@qping/plugin-bus 0.3.0 → 0.5.0

package/dist/actions.d.ts

@@ -151,27 +151,47 @@ export type DetailRequest = {
     page?: string;
     title?: string;
     initialState?: unknown;
+    /** Restricts the action bar for this detail page. Omit to expose every registered action. */
+    actions?: string[];
 };
-/**
- * The result of running an action. Every field is optional and they combine: opening an IDE and
- * closing the search window is `{ host: {...}, close: true }`.
- */
-export type ActionOutcome = {
-    /** Run a host-side action (clipboard, process launch, browser, ...). */
-    host?: HostActionRequest;
-    /** Hand off to the detail page; arrives as `host.event.detailAction` with this payload. */
-    web?: {
-        payload?: unknown;
-    };
-    /** Open a web detail page. */
-    detail?: DetailRequest;
+export type ActionTarget = 
+/** Run one privileged host-side action (clipboard, process launch, browser, ...). */
+{
+    kind: "host";
+    action: HostActionRequest;
+}
+/** Hand off to the currently active detail page as host.event.detailAction. */
+ | {
+    kind: "web";
+    payload?: unknown;
+}
+/** Open a new web detail page. */
+ | ({
+    kind: "detail";
+} & DetailRequest);
+export type ActionAfter = "keep" | "close" | "refresh";
+type ActionOutcomeBase = {
     /** Status bar text. */
     message?: LocalizedText;
-    /** Close the search window afterwards. Defaults to false. */
-    close?: boolean;
-    /** Refresh the current search results afterwards. Defaults to false. */
-    refresh?: boolean;
 };
+/**
+ * The result of running an action. An action selects at most one execution target. Host targets
+ * may choose a follow-up lifecycle action; web and detail targets keep their current surface alive.
+ */
+export type ActionOutcome = ActionOutcomeBase & ({
+    target?: undefined;
+    after?: ActionAfter;
+} | {
+    target: Extract<ActionTarget, {
+        kind: "host";
+    }>;
+    after?: ActionAfter;
+} | {
+    target: Exclude<ActionTarget, {
+        kind: "host";
+    }>;
+    after?: "keep";
+});
 /**
  * What an action sees when it runs. `item` is the original object returned by `search()`,
  * including fields the host never saw — the SDK keeps it so actions do not have to re-derive
@@ -202,3 +222,4 @@ export type ActionManifestEntry = {
     hotkey?: Hotkey;
 };
 export declare function toActionManifest(definition: ActionDefinition): ActionManifestEntry;
+export {};

package/dist/bootstrap.d.ts

@@ -26,11 +26,10 @@ export interface PluginRuntime {
 export declare function runPlugin(handlers: PluginHandlers): Promise<PluginRuntime>;
 /**
  * Sends bus.handshake with the bootstrap token and waits for the host response that binds
- * plugin/entry/session/endpoint identity. Rejects on HandshakeFailed / ProtocolMismatch / timeout.
+ * plugin/session/endpoint identity. Rejects on HandshakeFailed / ProtocolMismatch / timeout.
  */
 export declare function completeHandshake(transport: NodeTransport, token: string, timeoutMs?: number): Promise<{
     pluginId: string;
-    entryId: string;
     sessionId: string;
     endpointId: string;
 }>;

package/dist/bootstrap.mjs

@@ -295,7 +295,6 @@ var HandlerRouter = class {
   handlers = /* @__PURE__ */ new Map();
   pendingHostCalls = /* @__PURE__ */ new Map();
   pluginId = "p";
-  entryId = "e";
   sessionId = "s";
   endpointId = EndpointIds.NodeMain;
   /** Injected transport send fn; tests can override `router.send` directly. */
@@ -306,7 +305,6 @@ var HandlerRouter = class {
   /** Sets the bound identity stamped on outbound messages (after handshake). */
   setIdentity(ids) {
     this.pluginId = ids.pluginId;
-    this.entryId = ids.entryId;
     this.sessionId = ids.sessionId;
     this.endpointId = ids.endpointId;
   }
@@ -355,7 +353,6 @@ var HandlerRouter = class {
         traceId: id,
         sessionId: this.sessionId,
         pluginId: this.pluginId,
-        entryId: this.entryId,
         endpointId: this.endpointId,
         kind: MessageKind.Request,
         route,
@@ -402,7 +399,6 @@ var HandlerRouter = class {
       traceId: req.traceId,
       sessionId: req.sessionId,
       pluginId: req.pluginId,
-      entryId: req.entryId,
       endpointId: this.endpointId,
       kind: MessageKind.Response,
       route: req.route,
@@ -483,7 +479,6 @@ async function completeHandshake(transport, token, timeoutMs = 1e4) {
     traceId: id,
     sessionId: "",
     pluginId: "",
-    entryId: "",
     endpointId: EndpointIds.NodeMain,
     kind: MessageKind.Request,
     route: Routes.Bus.Handshake,
@@ -509,14 +504,13 @@ async function completeHandshake(transport, token, timeoutMs = 1e4) {
       }
       const p = env.payload ?? {};
       const pluginId = String(p.pluginId ?? "");
-      const entryId = String(p.entryId ?? "");
       const sessionId = String(p.sessionId ?? "");
       const endpointId = String(p.endpointId ?? EndpointIds.NodeMain);
-      if (!pluginId || !entryId || !sessionId) {
+      if (!pluginId || !sessionId) {
         reject(new Error("bus.handshake success response missing bound identity"));
         return;
       }
-      resolve({ pluginId, entryId, sessionId, endpointId });
+      resolve({ pluginId, sessionId, endpointId });
     });
     transport.send(req);
   });

package/dist/node.mjs

@@ -304,7 +304,6 @@ var HandlerRouter = class {
   handlers = /* @__PURE__ */ new Map();
   pendingHostCalls = /* @__PURE__ */ new Map();
   pluginId = "p";
-  entryId = "e";
   sessionId = "s";
   endpointId = EndpointIds.NodeMain;
   /** Injected transport send fn; tests can override `router.send` directly. */
@@ -315,7 +314,6 @@ var HandlerRouter = class {
   /** Sets the bound identity stamped on outbound messages (after handshake). */
   setIdentity(ids) {
     this.pluginId = ids.pluginId;
-    this.entryId = ids.entryId;
     this.sessionId = ids.sessionId;
     this.endpointId = ids.endpointId;
   }
@@ -364,7 +362,6 @@ var HandlerRouter = class {
         traceId: id,
         sessionId: this.sessionId,
         pluginId: this.pluginId,
-        entryId: this.entryId,
         endpointId: this.endpointId,
         kind: MessageKind.Request,
         route,
@@ -411,7 +408,6 @@ var HandlerRouter = class {
       traceId: req.traceId,
       sessionId: req.sessionId,
       pluginId: req.pluginId,
-      entryId: req.entryId,
       endpointId: this.endpointId,
       kind: MessageKind.Response,
       route: req.route,
@@ -492,7 +488,6 @@ async function completeHandshake(transport, token, timeoutMs = 1e4) {
     traceId: id,
     sessionId: "",
     pluginId: "",
-    entryId: "",
     endpointId: EndpointIds.NodeMain,
     kind: MessageKind.Request,
     route: Routes.Bus.Handshake,
@@ -518,14 +513,13 @@ async function completeHandshake(transport, token, timeoutMs = 1e4) {
       }
       const p = env.payload ?? {};
       const pluginId = String(p.pluginId ?? "");
-      const entryId = String(p.entryId ?? "");
       const sessionId = String(p.sessionId ?? "");
       const endpointId = String(p.endpointId ?? EndpointIds.NodeMain);
-      if (!pluginId || !entryId || !sessionId) {
+      if (!pluginId || !sessionId) {
         reject(new Error("bus.handshake success response missing bound identity"));
         return;
       }
-      resolve({ pluginId, entryId, sessionId, endpointId });
+      resolve({ pluginId, sessionId, endpointId });
     });
     transport.send(req);
   });
@@ -696,7 +690,6 @@ var Plugin = class {
       traceId: crypto.randomUUID().replace(/-/g, "").slice(0, 32),
       sessionId: "",
       pluginId: "",
-      entryId: "",
       endpointId: EndpointIds.NodeMain,
       kind: MessageKind.Event,
       route,

package/dist/protocol.d.ts

@@ -88,7 +88,6 @@ export interface Envelope {
     traceId: string;
     sessionId: string;
     pluginId: string;
-    entryId: string;
     endpointId: string;
     kind: MessageKind;
     route: string;

package/dist/router.d.ts

@@ -16,7 +16,6 @@ export declare class HandlerRouter {
     private handlers;
     private pendingHostCalls;
     private pluginId;
-    private entryId;
     private sessionId;
     private endpointId;
     /** Injected transport send fn; tests can override `router.send` directly. */
@@ -27,7 +26,6 @@ export declare class HandlerRouter {
     /** Sets the bound identity stamped on outbound messages (after handshake). */
     setIdentity(ids: {
         pluginId: string;
-        entryId: string;
         sessionId: string;
         endpointId: string;
     }): void;

package/dist/webClient.mjs

@@ -2545,7 +2545,6 @@ function createWebBusClient(options) {
           traceId: id,
           sessionId: "",
           pluginId: "",
-          entryId: "",
           endpointId: "",
           kind: MessageKind.Request,
           route,
@@ -2607,7 +2606,6 @@ function handshake(timeoutMs) {
       traceId: id,
       sessionId: "",
       pluginId: "",
-      entryId: "",
       endpointId: "web",
       kind: MessageKind.Request,
       route: Routes.Bus.Handshake,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qping/plugin-bus",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "v3 message-bus runtime for MyTools plugins (named-pipe transport).",
   "type": "module",
   "files": [
@@ -28,17 +28,17 @@
       "import": "./dist/webClient.mjs",
       "default": "./dist/webClient.mjs"
     },
-    "./i18n": {
-      "types": "./dist/i18n.d.ts",
-      "import": "./dist/i18n.mjs",
-      "default": "./dist/i18n.mjs"
-    },
-    "./search": {
-      "types": "./dist/search.d.ts",
-      "import": "./dist/search.mjs",
-      "default": "./dist/search.mjs"
-    },
-    "./dev": {
+    "./i18n": {
+      "types": "./dist/i18n.d.ts",
+      "import": "./dist/i18n.mjs",
+      "default": "./dist/i18n.mjs"
+    },
+    "./search": {
+      "types": "./dist/search.d.ts",
+      "import": "./dist/search.mjs",
+      "default": "./dist/search.mjs"
+    },
+    "./dev": {
       "types": "./dist/dev.d.ts",
       "import": "./dist/dev.mjs",
       "default": "./dist/dev.mjs"

package/src/actions.ts

@@ -94,26 +94,34 @@ export type DetailRequest = {
   page?: string;
   title?: string;
   initialState?: unknown;
+  /** Restricts the action bar for this detail page. Omit to expose every registered action. */
+  actions?: string[];
 };
 
-/**
- * The result of running an action. Every field is optional and they combine: opening an IDE and
- * closing the search window is `{ host: {...}, close: true }`.
- */
-export type ActionOutcome = {
-  /** Run a host-side action (clipboard, process launch, browser, ...). */
-  host?: HostActionRequest;
-  /** Hand off to the detail page; arrives as `host.event.detailAction` with this payload. */
-  web?: { payload?: unknown };
-  /** Open a web detail page. */
-  detail?: DetailRequest;
+export type ActionTarget =
+  /** Run one privileged host-side action (clipboard, process launch, browser, ...). */
+  | { kind: "host"; action: HostActionRequest }
+  /** Hand off to the currently active detail page as host.event.detailAction. */
+  | { kind: "web"; payload?: unknown }
+  /** Open a new web detail page. */
+  | ({ kind: "detail" } & DetailRequest);
+
+export type ActionAfter = "keep" | "close" | "refresh";
+
+type ActionOutcomeBase = {
   /** Status bar text. */
   message?: LocalizedText;
-  /** Close the search window afterwards. Defaults to false. */
-  close?: boolean;
-  /** Refresh the current search results afterwards. Defaults to false. */
-  refresh?: boolean;
-};
+};
+
+/**
+ * The result of running an action. An action selects at most one execution target. Host targets
+ * may choose a follow-up lifecycle action; web and detail targets keep their current surface alive.
+ */
+export type ActionOutcome = ActionOutcomeBase & (
+  | { target?: undefined; after?: ActionAfter }
+  | { target: Extract<ActionTarget, { kind: "host" }>; after?: ActionAfter }
+  | { target: Exclude<ActionTarget, { kind: "host" }>; after?: "keep" }
+);
 
 /**
  * What an action sees when it runs. `item` is the original object returned by `search()`,

package/src/bootstrap.ts

@@ -102,13 +102,13 @@ async function readBootstrapLine(): Promise<{ pipePath: string; token: string }>
 
 /**
  * Sends bus.handshake with the bootstrap token and waits for the host response that binds
- * plugin/entry/session/endpoint identity. Rejects on HandshakeFailed / ProtocolMismatch / timeout.
+ * plugin/session/endpoint identity. Rejects on HandshakeFailed / ProtocolMismatch / timeout.
  */
 export async function completeHandshake(
   transport: NodeTransport,
   token: string,
   timeoutMs = 10000,
-): Promise<{ pluginId: string; entryId: string; sessionId: string; endpointId: string }> {
+): Promise<{ pluginId: string; sessionId: string; endpointId: string }> {
   const id = randomBytes(16).toString("hex");
   const req: Envelope = {
     version: ProtocolVersion,
@@ -116,7 +116,6 @@ export async function completeHandshake(
     traceId: id,
     sessionId: "",
     pluginId: "",
-    entryId: "",
     endpointId: EndpointIds.NodeMain,
     kind: MessageKind.Request,
     route: Routes.Bus.Handshake,
@@ -144,14 +143,13 @@ export async function completeHandshake(
       }
       const p = (env.payload ?? {}) as Record<string, unknown>;
       const pluginId = String(p.pluginId ?? "");
-      const entryId = String(p.entryId ?? "");
       const sessionId = String(p.sessionId ?? "");
       const endpointId = String(p.endpointId ?? EndpointIds.NodeMain);
-      if (!pluginId || !entryId || !sessionId) {
+      if (!pluginId || !sessionId) {
         reject(new Error("bus.handshake success response missing bound identity"));
         return;
       }
-      resolve({ pluginId, entryId, sessionId, endpointId });
+      resolve({ pluginId, sessionId, endpointId });
     });
 
     transport.send(req);

package/src/node.ts

@@ -153,7 +153,6 @@ export class Plugin {
       traceId: crypto.randomUUID().replace(/-/g, "").slice(0, 32),
       sessionId: "",
       pluginId: "",
-      entryId: "",
       endpointId: EndpointIds.NodeMain,
       kind: MessageKind.Event,
       route,

package/src/protocol.ts

@@ -110,7 +110,6 @@ export interface Envelope {
   traceId: string;
   sessionId: string;
   pluginId: string;
-  entryId: string;
   endpointId: string;
   kind: MessageKind;
   route: string;

package/src/router.ts

@@ -62,7 +62,6 @@ export class HandlerRouter {
   private handlers = new Map<string, Handler>();
   private pendingHostCalls = new Map<string, PendingHostCall>();
   private pluginId = "p";
-  private entryId = "e";
   private sessionId = "s";
   private endpointId: string = EndpointIds.NodeMain;
 
@@ -74,9 +73,8 @@ export class HandlerRouter {
   }
 
   /** Sets the bound identity stamped on outbound messages (after handshake). */
-  setIdentity(ids: { pluginId: string; entryId: string; sessionId: string; endpointId: string }): void {
+  setIdentity(ids: { pluginId: string; sessionId: string; endpointId: string }): void {
     this.pluginId = ids.pluginId;
-    this.entryId = ids.entryId;
     this.sessionId = ids.sessionId;
     this.endpointId = ids.endpointId;
   }
@@ -133,7 +131,6 @@ export class HandlerRouter {
         traceId: id,
         sessionId: this.sessionId,
         pluginId: this.pluginId,
-        entryId: this.entryId,
         endpointId: this.endpointId,
         kind: MessageKind.Request,
         route,
@@ -176,7 +173,6 @@ export class HandlerRouter {
       traceId: req.traceId,
       sessionId: req.sessionId,
       pluginId: req.pluginId,
-      entryId: req.entryId,
       endpointId: this.endpointId,
       kind: MessageKind.Response,
       route: req.route,

package/src/webClient.ts

@@ -208,7 +208,6 @@ export function createWebBusClient(options?: {
             traceId: id,
             sessionId: "",
             pluginId: "",
-            entryId: "",
             endpointId: "",
             kind: MessageKind.Request,
             route,
@@ -277,7 +276,6 @@ function handshake(timeoutMs: number): Promise<string> {
       traceId: id,
       sessionId: "",
       pluginId: "",
-      entryId: "",
       endpointId: "web",
       kind: MessageKind.Request,
       route: Routes.Bus.Handshake,