@xpufx/paseo-helper-demo 0.2.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/demo.ts

@@ -0,0 +1,155 @@
+import {
+  defineContract,
+  defineSettingsContract,
+  type RpcOutput,
+} from "paseo-plugin-helper/shared";
+import { z } from "zod";
+
+export const DemoSettingsSchema = z.object({
+  showCpuUsage: z.boolean().default(true),
+  accentPillLabel: z.string().default("demo"),
+  pollingRate: z.enum(["1s", "2s", "5s", "paused"]).default("2s"),
+  navigationStyle: z.enum(["tabs", "dropdown"]).default("dropdown"),
+  highCpuThreshold: z.number().default(80),
+  // Visual Flair Customization Studio (Persisted)
+  flairRadius: z.enum(["sharp", "rounded", "pill"]).default("rounded"),
+  flairDensity: z.enum(["compact", "comfortable", "spacious"]).default("comfortable"),
+  flairSurface: z.enum(["flat", "tinted", "elevated"]).default("flat"),
+  flairBorderWidth: z.number().default(1),
+  flairUppercase: z.boolean().default(false),
+  flairAccentColor: z.string().default("#6366f1"),
+});
+
+export type DemoSettings = z.infer<typeof DemoSettingsSchema>;
+
+export type DemoNavigationStyle = DemoSettings["navigationStyle"];
+
+/**
+ * Maps the showcase navigation style to ModalBody scroll ownership.
+ * Tabs use a compact pinned navbar (headerMode="pinned": header stays fixed
+ * while the body scrolls). The dropdown menu is in-flow inside the header,
+ * so it must participate in the scroll flow (headerMode="scroll"): on
+ * helper-owned compact surfaces the header renders INSIDE the ScrollView,
+ * and on host-owned 0.8 popovers it drops the sticky header, so an open
+ * menu scrolls with the content instead of staying visibly pinned while
+ * the body scrolls beneath it.
+ */
+export function resolveDemoHeaderMode(
+  navigationStyle: DemoNavigationStyle,
+): "pinned" | "scroll" {
+  return navigationStyle === "dropdown" ? "scroll" : "pinned";
+}
+
+export const demoSettingsContract = defineSettingsContract({
+  name: "helper-demo.settings",
+  schema: DemoSettingsSchema,
+  description: "Showcase demo settings",
+});
+
+export const getDemoDataRpc = defineContract({
+  name: "helper-demo.get-data",
+  description: "Get comprehensive demo metrics, hardware stats, and service items",
+  input: z.object({}),
+  output: z.object({
+    version: z.string(),
+    hostname: z.string(),
+    platform: z.string(),
+    cpuModel: z.string(),
+    cpuUsagePercent: z.number(),
+    memoryUsedPercent: z.number(),
+    memoryUsedBytes: z.number(),
+    memoryTotalBytes: z.number(),
+    loadAvg: z.array(z.number()),
+    uptimeSeconds: z.number(),
+    daemonPort: z.number(),
+    backgroundTicks: z.number(),
+    items: z.array(
+      z.object({
+        id: z.string(),
+        name: z.string(),
+        category: z.string(),
+        status: z.enum(["running", "idle", "syncing", "warning"]),
+        loadPercent: z.number(),
+      })
+    ),
+  }),
+});
+
+export const triggerDemoActionRpc = defineContract({
+  name: "helper-demo.trigger-action",
+  description: "Trigger an RPC action on the daemon",
+  input: z.object({
+    actionName: z.string(),
+  }),
+  output: z.object({
+    success: z.boolean(),
+    message: z.string(),
+  }),
+});
+
+export type DemoData = RpcOutput<typeof getDemoDataRpc>;
+
+export const demoAgentIdentityContract = defineContract({
+  name: "helper-demo.agent-identity",
+  description: "Get active agent identity and session for self-inspection",
+  input: z.object({}),
+  output: z.object({
+    identity: z
+      .object({
+        id: z.string().optional(),
+        name: z.string().optional(),
+        model: z.string().optional(),
+        provider: z.string().optional(),
+        repo: z.string().optional(),
+        branch: z.string().optional(),
+        envelopeText: z.string().optional(),
+      })
+      .nullable(),
+  }),
+});
+
+export type DemoAgentIdentity = RpcOutput<typeof demoAgentIdentityContract>;
+
+export const demoBeaconSetContract = defineContract({
+  name: "helper-demo.beacon-set",
+  description: "Set workspace status beacon label on the active workspace",
+  input: z.object({
+    workspaceId: z.string().min(1),
+    name: z.string().default("DEMO:ACTIVE"),
+    color: z.string().default("sky"),
+  }),
+  output: z.object({
+    success: z.boolean(),
+    message: z.string(),
+    labelApplied: z.boolean(),
+    titleApplied: z.boolean(),
+  }),
+});
+
+export const demoBeaconBlinkContract = defineContract({
+  name: "helper-demo.beacon-blink",
+  description: "Blink workspace beacon between emerald and orange states",
+  input: z.object({
+    workspaceId: z.string().min(1),
+    rounds: z.number().int().positive().default(5),
+  }),
+  output: z.object({
+    success: z.boolean(),
+    message: z.string(),
+  }),
+});
+
+export const demoBeaconClearContract = defineContract({
+  name: "helper-demo.beacon-clear",
+  description: "Clear workspace beacon label and restore original title",
+  input: z.object({
+    workspaceId: z.string().min(1),
+    name: z.string().default("DEMO:ACTIVE"),
+  }),
+  output: z.object({
+    success: z.boolean(),
+    message: z.string(),
+    labelCleared: z.boolean(),
+    titleRestored: z.boolean(),
+  }),
+});

package/shared/vendor/paseo-plugin-helper/README.md

@@ -0,0 +1,11 @@
+# Vendored paseo-plugin-helper (Track B of issue #71)
+
+Pinned helper version: 0.4.0-beta.12
+
+Docs: https://github.com/xpufx/paseo/tree/main/packages/paseo-plugin-helper — npm: https://www.npmjs.com/package/paseo-plugin-helper
+
+Zero host requirements (no npm, no registry, no build key): the daemon bundles
+this source directly. Layout: `client/`, `server/`, `shared/` vendor splits
+mapping helper `src/client`, `src/server`, `src/shared` (daemon accepts modules
+only under those dirs). Updating: run `make vendor-sync` and bump the pinned
+version above.

package/shared/vendor/paseo-plugin-helper/async.ts

@@ -0,0 +1,35 @@
+export class TimeoutError extends Error {
+  readonly timeoutMs: number;
+
+  constructor(message: string, timeoutMs: number) {
+    super(message);
+    this.name = "TimeoutError";
+    this.timeoutMs = timeoutMs;
+  }
+}
+
+/**
+ * Races a promise against a timeout duration in milliseconds.
+ * If the timeout expires before the promise resolves, rejects with a TimeoutError.
+ * Automatically cleans up the timer on resolution or rejection.
+ */
+export async function withTimeout<T>(
+  promise: Promise<T>,
+  timeoutMs: number,
+  label = "Operation"
+): Promise<T> {
+  let timer: any;
+  const timeoutPromise = new Promise<never>((_, reject) => {
+    timer = setTimeout(() => {
+      reject(new TimeoutError(`${label} timed out after ${timeoutMs}ms`, timeoutMs));
+    }, timeoutMs);
+  });
+
+  try {
+    return await Promise.race([promise, timeoutPromise]);
+  } finally {
+    if (timer !== undefined) {
+      clearTimeout(timer);
+    }
+  }
+}