@xpufx/paseo-x-comms 0.3.0

package/server/vendor/paseo-plugin-helper/workspace-beacon.ts

@@ -0,0 +1,418 @@
+import type { PluginLogger } from "./logger";
+
+export const DEFAULT_BEACON_LABEL_PREFIX = "beacon:";
+
+export const BEACON_COLORS = [
+  "violet",
+  "sky",
+  "emerald",
+  "orange",
+  "pink",
+  "indigo",
+  "teal",
+  "red",
+  "amber",
+  "blue",
+] as const;
+
+export type BeaconColor = (typeof BEACON_COLORS)[number];
+
+export interface BeaconLabelState {
+  name: string;
+  color?: string;
+  titleSuffix?: string;
+  title?: string;
+  workspaceId?: string;
+}
+
+export interface BeaconSetOptions extends BeaconLabelState {
+  workspaceId: string;
+}
+
+export interface BeaconBlinkOptions {
+  workspaceId?: string;
+  a: BeaconLabelState;
+  b: BeaconLabelState;
+  intervalMs?: number;
+  rounds?: number;
+  restoreOnDone?: boolean;
+}
+
+export interface BeaconClearOptions {
+  workspaceId?: string;
+  name?: string;
+  restoreTitle?: boolean;
+}
+
+export interface WorkspaceTitleHandle {
+  setTitle?: (title: string) => unknown;
+}
+
+export interface BeaconDaemonClient {
+  setWorkspaceLabel?: (args: unknown) => unknown;
+  updateWorkspaceLabel?: (args: unknown) => unknown;
+  removeWorkspaceLabel?: (args: unknown) => unknown;
+  [key: string]: unknown;
+}
+
+export interface WorkspaceBeaconOptions {
+  workspaceHandle?: WorkspaceTitleHandle | null;
+  daemonClient?: BeaconDaemonClient | null;
+  labelPrefix?: string;
+  baseTitle?: string;
+  logger?: PluginLogger;
+}
+
+export interface BeaconSetResult {
+  labelApplied: boolean;
+  titleApplied: boolean;
+  labelName?: string;
+  title?: string;
+}
+
+export interface BeaconClearResult {
+  labelCleared: boolean;
+  titleRestored: boolean;
+}
+
+export interface BeaconBlinkHandle {
+  stop: () => void;
+  done: Promise<void>;
+}
+
+export function resolveBeaconLabelName(
+  name: string,
+  prefix: string = DEFAULT_BEACON_LABEL_PREFIX,
+): string {
+  const trimmed = (name ?? "").trim();
+  if (!prefix) return trimmed;
+  if (trimmed.toLowerCase().startsWith(prefix.toLowerCase())) return trimmed;
+  return `${prefix}${trimmed}`;
+}
+
+export function normalizeBeaconColor(color: string | undefined): string | undefined {
+  if (!color) return undefined;
+  const normalized = color.trim().toLowerCase();
+  if ((BEACON_COLORS as readonly string[]).includes(normalized)) return normalized;
+  return undefined;
+}
+
+function isFunction(value: unknown): value is (...args: never[]) => unknown {
+  return typeof value === "function";
+}
+
+async function safeInvoke(
+  fn: () => unknown,
+  logger?: PluginLogger,
+): Promise<boolean> {
+  try {
+    await fn();
+    return true;
+  } catch (err) {
+    logger?.debug?.(
+      `WorkspaceBeacon host call failed: ${err instanceof Error ? err.message : String(err)}`,
+    );
+    return false;
+  }
+}
+
+function toTimerKey(workspaceId: string | undefined): string {
+  return workspaceId ?? "__default__";
+}
+
+export class WorkspaceBeacon {
+  private workspaceHandle?: WorkspaceTitleHandle | null;
+  private daemonClient?: BeaconDaemonClient | null;
+  private labelPrefix: string;
+  private baseTitle?: string;
+  private logger?: PluginLogger;
+  private originalTitles = new Map<string, string>();
+  private blinkTimers = new Map<string, { timer: ReturnType<typeof setInterval>; finish: () => void }>();
+
+  constructor(options: WorkspaceBeaconOptions = {}) {
+    this.workspaceHandle = options.workspaceHandle ?? null;
+    this.daemonClient = options.daemonClient ?? null;
+    this.labelPrefix = options.labelPrefix ?? DEFAULT_BEACON_LABEL_PREFIX;
+    this.baseTitle = options.baseTitle;
+    this.logger = options.logger;
+  }
+
+  setOptions(options: Partial<WorkspaceBeaconOptions>): void {
+    if ("workspaceHandle" in options) this.workspaceHandle = options.workspaceHandle ?? null;
+    if ("daemonClient" in options) this.daemonClient = options.daemonClient ?? null;
+    if (options.labelPrefix !== undefined) this.labelPrefix = options.labelPrefix;
+    if (options.baseTitle !== undefined) this.baseTitle = options.baseTitle;
+    if (options.logger !== undefined) this.logger = options.logger;
+  }
+
+  get activeBlinks(): number {
+    return this.blinkTimers.size;
+  }
+
+  async set(options: BeaconSetOptions): Promise<BeaconSetResult> {
+    const result: BeaconSetResult = { labelApplied: false, titleApplied: false };
+    try {
+      const workspaceId = options.workspaceId;
+      const labelName = options.name ? resolveBeaconLabelName(options.name, this.labelPrefix) : undefined;
+      result.labelName = labelName;
+
+      if (workspaceId && labelName) {
+        result.labelApplied = await this.applyLabel(workspaceId, labelName, options.color);
+      }
+
+      const title = this.resolveTitle(options);
+      if (title !== undefined) {
+        result.titleApplied = await this.applyTitle(workspaceId, title);
+        if (result.titleApplied) result.title = title;
+      }
+    } catch (err) {
+      this.logger?.debug?.(
+        `WorkspaceBeacon.set failed: ${err instanceof Error ? err.message : String(err)}`,
+      );
+    }
+    return result;
+  }
+
+  blink(options: BeaconBlinkOptions): BeaconBlinkHandle {
+    const intervalMs = Math.max(50, options.intervalMs ?? 3000);
+    const totalRounds = options.rounds ?? Number.POSITIVE_INFINITY;
+    const workspaceId = options.workspaceId ?? options.a.workspaceId ?? options.b.workspaceId;
+    const key = toTimerKey(workspaceId);
+    this.stopBlink(key);
+    let stopped = false;
+    let settled = false;
+    let timer: ReturnType<typeof setInterval> | undefined;
+    let resolveDone!: () => void;
+    const done = new Promise<void>((resolve) => {
+      resolveDone = resolve;
+    });
+    const finish = () => {
+      if (settled) return;
+      settled = true;
+      if (timer) clearInterval(timer);
+      const current = this.blinkTimers.get(key);
+      if (current?.finish === finish) this.blinkTimers.delete(key);
+      if (options.restoreOnDone) {
+        void this.clear({
+          workspaceId,
+          name: options.a.name ?? options.b.name,
+          restoreTitle: true,
+        }).catch((err) =>
+          this.logger?.debug?.(
+            `WorkspaceBeacon blink restore failed: ${err instanceof Error ? err.message : String(err)}`,
+          ),
+        );
+      }
+      resolveDone();
+    };
+
+    try {
+      const states: BeaconLabelState[] = [options.a, options.b];
+      const tick = () => {
+        if (stopped) {
+          finish();
+          return;
+        }
+        if (count >= totalRounds) {
+          finish();
+          return;
+        }
+        const state = states[count % 2];
+        count += 1;
+        void this.set({ ...state, workspaceId: state.workspaceId ?? workspaceId ?? "" }).catch((err) =>
+          this.logger?.debug?.(
+            `WorkspaceBeacon blink tick failed: ${err instanceof Error ? err.message : String(err)}`,
+          ),
+        );
+        if (count >= totalRounds) {
+          finish();
+        }
+      };
+      let count = 0;
+      void this.set({ ...states[0], workspaceId: states[0].workspaceId ?? workspaceId ?? "" }).catch(
+        (err) =>
+          this.logger?.debug?.(
+            `WorkspaceBeacon blink tick failed: ${err instanceof Error ? err.message : String(err)}`,
+          ),
+      );
+      count = 1;
+      if (count >= totalRounds) {
+        finish();
+      } else {
+        timer = setInterval(tick, intervalMs);
+        this.blinkTimers.set(key, { timer, finish });
+      }
+    } catch (err) {
+      this.logger?.debug?.(
+        `WorkspaceBeacon blink setup failed: ${err instanceof Error ? err.message : String(err)}`,
+      );
+      finish();
+    }
+
+    return {
+      stop: () => {
+        stopped = true;
+        finish();
+      },
+      done,
+    };
+  }
+
+  async clear(options: BeaconClearOptions = {}): Promise<BeaconClearResult> {
+    const result: BeaconClearResult = { labelCleared: false, titleRestored: false };
+    try {
+      this.stopBlink(toTimerKey(options.workspaceId));
+      if (options.workspaceId && options.name) {
+        result.labelCleared = await this.detachLabel(
+          options.workspaceId,
+          resolveBeaconLabelName(options.name, this.labelPrefix),
+        );
+      } else if (options.workspaceId && !options.name) {
+        result.labelCleared = false;
+      }
+      if (options.restoreTitle !== false) {
+        result.titleRestored = await this.restoreTitle(options.workspaceId);
+      }
+    } catch (err) {
+      this.logger?.debug?.(
+        `WorkspaceBeacon.clear failed: ${err instanceof Error ? err.message : String(err)}`,
+      );
+    }
+    return result;
+  }
+
+  stopAll(): void {
+    for (const entry of this.blinkTimers.values()) {
+      clearInterval(entry.timer);
+      try {
+        entry.finish();
+      } catch (err) {
+        this.logger?.debug?.(
+          `WorkspaceBeacon stopAll finish failed: ${err instanceof Error ? err.message : String(err)}`,
+        );
+      }
+    }
+    this.blinkTimers.clear();
+  }
+
+  private resolveTitle(options: BeaconLabelState): string | undefined {
+    if (options.title !== undefined) return options.title;
+    if (options.titleSuffix === undefined) return undefined;
+    const base = this.originalTitles.get(options.workspaceId ?? "") ?? this.baseTitle ?? "";
+    return `${base}${options.titleSuffix}`;
+  }
+
+  private async applyLabel(workspaceId: string, labelName: string, color?: string): Promise<boolean> {
+    const client = this.daemonClient;
+    if (!client || !isFunction(client.setWorkspaceLabel)) return false;
+    const label: Record<string, string> = { name: labelName };
+    const normalized = normalizeBeaconColor(color);
+    if (normalized) label.color = normalized;
+    else if (color) label.color = color;
+    return safeInvoke(
+      () =>
+        (client.setWorkspaceLabel as (args: unknown) => unknown)({
+          workspaceId,
+          label,
+          assigned: true,
+        }),
+      this.logger,
+    );
+  }
+
+  private async detachLabel(workspaceId: string, labelName: string): Promise<boolean> {
+    const client = this.daemonClient as BeaconDaemonClient | null | undefined;
+    if (!client) return false;
+    try {
+      if (isFunction(client.setWorkspaceLabel)) {
+        return await safeInvoke(
+          () =>
+            (client.setWorkspaceLabel as (args: unknown) => unknown)({
+              workspaceId,
+              label: { name: labelName },
+              assigned: false,
+            }),
+          this.logger,
+        );
+      }
+      if (isFunction(client.removeWorkspaceLabel)) {
+        return await safeInvoke(
+          () =>
+            (client.removeWorkspaceLabel as (args: unknown) => unknown)({
+              workspaceId,
+              name: labelName,
+            }),
+          this.logger,
+        );
+      }
+      return false;
+    } catch (err) {
+      this.logger?.debug?.(
+        `WorkspaceBeacon detachLabel failed: ${err instanceof Error ? err.message : String(err)}`,
+      );
+      return false;
+    }
+  }
+
+  setOriginalTitle(workspaceId: string, title: string): void {
+    this.originalTitles.set(workspaceId, title);
+  }
+
+  hasOriginalTitle(workspaceId: string): boolean {
+    return this.originalTitles.has(workspaceId);
+  }
+
+  getOriginalTitle(workspaceId: string): string | undefined {
+    return this.originalTitles.get(workspaceId);
+  }
+
+  private async applyTitle(workspaceId: string | undefined, title: string): Promise<boolean> {
+    const handle = this.workspaceHandle;
+    if (!handle || !isFunction(handle.setTitle)) return false;
+    const key = workspaceId ?? "";
+    if (!this.originalTitles.has(key)) {
+      if (this.baseTitle !== undefined) {
+        this.originalTitles.set(key, this.baseTitle);
+      }
+    }
+    return safeInvoke(() => (handle.setTitle as (t: string) => unknown)(title), this.logger);
+  }
+
+  private async restoreTitle(workspaceId: string | undefined): Promise<boolean> {
+    const handle = this.workspaceHandle;
+    if (!handle || !isFunction(handle.setTitle)) return false;
+    const key = workspaceId ?? "";
+    const original = this.originalTitles.get(key) ?? this.baseTitle;
+    if (original === undefined) return false;
+    const ok = await safeInvoke(
+      () => (handle.setTitle as (t: string) => unknown)(original),
+      this.logger,
+    );
+    if (ok) {
+      this.originalTitles.delete(key);
+      if (this.baseTitle === original) {
+        this.baseTitle = undefined;
+      }
+    }
+    return ok;
+  }
+
+  private stopBlink(key: string): void {
+    const entry = this.blinkTimers.get(key);
+    if (entry) {
+      clearInterval(entry.timer);
+      this.blinkTimers.delete(key);
+      try {
+        entry.finish();
+      } catch (err) {
+        this.logger?.debug?.(
+          `WorkspaceBeacon stopBlink finish failed: ${err instanceof Error ? err.message : String(err)}`,
+        );
+      }
+    }
+  }
+}
+
+export function createWorkspaceBeacon(options: WorkspaceBeaconOptions = {}): WorkspaceBeacon {
+  return new WorkspaceBeacon(options);
+}

package/shared/conversations-snapshot.ts

@@ -0,0 +1,39 @@
+import { z } from "zod";
+
+/**
+ * Shared conversations snapshot for cross-plugin readers (top, mcp-tools).
+ * Plain data only: no SDK types, so any consumer parses it with plain JSON.
+ *
+ * Writers: the x-comms plugin server updates it on every send and on every
+ * timeline reconcile (receives), and prunes on retract/archive. Readers
+ * never probe and never touch timelines; they read the file and render.
+ */
+
+export const CONVERSATIONS_SNAPSHOT_VERSION = 1 as const;
+
+export const XCommsThreadSnapshotSchema = z.object({
+  peerAlias: z.string(),
+  peerServerId: z.string(),
+  peerAgentId: z.string(),
+  peerAgentName: z.string().nullable(),
+  localAgentIds: z.array(z.string()),
+  lastDirection: z.enum(["incoming", "outgoing"]),
+  lastTimestamp: z.string(),
+  lastReadAt: z.string(),
+  lastSeenAt: z.string(),
+  unreadCount: z.number().int().nonnegative(),
+});
+
+export type XCommsThreadSnapshot = z.infer<typeof XCommsThreadSnapshotSchema>;
+
+export const XCommsConversationsSnapshotSchema = z.object({
+  version: z.literal(CONVERSATIONS_SNAPSHOT_VERSION),
+  updatedAt: z.string(),
+  threads: z.array(XCommsThreadSnapshotSchema),
+});
+
+export type XCommsConversationsSnapshot = z.infer<typeof XCommsConversationsSnapshotSchema>;
+
+export function emptyConversationsSnapshot(): XCommsConversationsSnapshot {
+  return { version: CONVERSATIONS_SNAPSHOT_VERSION, updatedAt: new Date(0).toISOString(), threads: [] };
+}

package/shared/envelope.ts

@@ -0,0 +1,92 @@
+import { z } from "zod";
+
+/**
+ * The x-comms wire envelope: a `[x-comms] ` prefixed JSON block stamped on
+ * every cross-daemon message. Pure parsing with no UI imports so the
+ * conversation derive and its tests run anywhere.
+ */
+
+export const META_PREFIX = "[x-comms] ";
+
+export const EnvelopeSchema = z.object({
+  xComms: z.object({
+    version: z.number(),
+    type: z.string(),
+    direction: z.enum(["incoming", "outgoing"]).optional(),
+    sender: z.object({
+      agentId: z.string().nullable(),
+      agentName: z.string().nullable(),
+      host: z.string().nullable(),
+      daemonServerId: z.string().nullable(),
+      cwd: z.string().nullable(),
+    }),
+    target: z.object({
+      daemon: z.string().nullable(),
+      agentId: z.string().nullable(),
+    }),
+    sentAt: z.string(),
+  }),
+});
+
+export type CrossDaemonEnvelope = z.infer<typeof EnvelopeSchema>;
+
+export type MessageDirection = "incoming" | "outgoing";
+
+/**
+ * Viewer-relative direction. The wire envelope stamps direction "outgoing"
+ * from the sender's side, so only a message from self counts as user-sent.
+ */
+export function viewerDirection(env: CrossDaemonEnvelope, viewerAgentId: string): MessageDirection {
+  const senderId = env.xComms.sender.agentId;
+  return senderId !== null && senderId === viewerAgentId ? "outgoing" : "incoming";
+}
+
+export interface CardSignal {
+  direction: MessageDirection;
+  userSent: boolean;
+}
+
+/**
+ * Pure card signal: red is reserved for user-sent messages only. Peer and
+ * agent arrivals render neutral. Never derive red from envelope defaults.
+ */
+export function cardSignal(env: CrossDaemonEnvelope, viewerAgentId: string): CardSignal {
+  const direction = viewerDirection(env, viewerAgentId);
+  return { direction, userSent: direction === "outgoing" };
+}
+
+/**
+ * Collapsed preview shows this many lines. Measured overflow (via
+ * onTextLayout) decides whether a Show more toggle appears at all.
+ */
+export const COLLAPSED_LINES = 3;
+
+/**
+ * Pure overflow rule for collapsible bodies: only bodies rendering more
+ * lines than the collapsed preview get a toggle. Short messages never do.
+ */
+export function isOverflowing(lineCount: number, maxLines: number = COLLAPSED_LINES): boolean {
+  return lineCount > maxLines;
+}
+
+/**
+ * Splits a message body into its x-comms envelope (if present) and the
+ * remaining human-visible text. The envelope is a prefix our server stamps on
+ * every x-comms message; its mere presence is the signal we render on.
+ */
+export function parseEnvelope(text: string): { envelope: CrossDaemonEnvelope; body: string } | null {
+  if (!text.startsWith(META_PREFIX)) return null;
+  const rest = text.slice(META_PREFIX.length).trimStart();
+  const sep = rest.indexOf("\n\n");
+  const json = sep === -1 ? rest : rest.slice(0, sep);
+  const body = sep === -1 ? "" : rest.slice(sep + 2).trim();
+  let raw: unknown;
+  try {
+    raw = JSON.parse(json);
+  } catch {
+    return null;
+  }
+  const parsed = EnvelopeSchema.safeParse(raw);
+  if (!parsed.success) return null;
+  return { envelope: parsed.data, body };
+}

package/shared/outbox.ts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+
+/**
+ * Shared contract for the outbox expiry notice. The daemon appends one of
+ * these to the sender's local timeline when a held message expires; the client
+ * registers a renderer for it. Kept out of the wire envelope on purpose: the
+ * notice is local to the sender's daemon (see #12 — no wire change).
+ */
+
+export const OUTBOX_NOTICE_KIND = "x-comms-outbox-notice";
+export const OUTBOX_NOTICE_VERSION = 1;
+
+export const OutboxNoticeSchema = z.object({
+  daemon: z.string(),
+  agentId: z.string(),
+  reason: z.string(),
+  attempts: z.number(),
+  heldForMs: z.number(),
+});
+
+export type OutboxNotice = z.infer<typeof OutboxNoticeSchema>;