glimpse-sdk 0.5.0 → 0.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glimpse-sdk",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Typed async framework for building Glimpse exec applets",
   "type": "module",
   "main": "dist/src/index.js",

package/src/app.ts

@@ -1,4 +1,5 @@
 import { createInterface } from "node:readline";
+import { spawn } from "node:child_process";
 
 import {
   type CallbackEvent,
@@ -13,7 +14,7 @@ import {
   parseInitEvent,
 } from "./events.js";
 import { StatusItem } from "./protocol.js";
-import { type TreeNode } from "./widgets.js";
+import { type TreeNode, InlineHandlerRegistry } from "./widgets.js";
 
 type Handler<EventT> = (event: EventT) => void | Promise<void>;
 
@@ -23,18 +24,14 @@ interface OutgoingMessage {
   line: string;
 }
 
-interface ShowNotificationArgs {
-  summary: string;
+interface ShowNotificationOptions {
   body?: string;
-  urgency?: string;
 }
 
-interface OpenUriArgs {
-  uri: string;
-}
-
-interface CopyToClipboardArgs {
-  text: string;
+export interface CommandResult {
+  stdout: string;
+  stderr: string;
+  rc: number;
 }
 
 interface DismissNotificationArgs {
@@ -45,6 +42,7 @@ export abstract class Applet<State extends object> {
   state: State;
 
   private readonly handlerMap = new Map<string, Handler<CallbackEvent>>();
+  private inlineHandlerMap = new Map<string, (event: CallbackEvent) => void | Promise<void>>();
   private readonly outgoing: OutgoingMessage[] = [];
   private flushPromise: Promise<void> | null = null;
   private renderQueued = false;
@@ -58,6 +56,10 @@ export abstract class Applet<State extends object> {
 
   protected abstract initialState(): State;
 
+  protected cssClass(): string | null {
+    return null;
+  }
+
   protected async onStart(): Promise<void> {}
 
   protected async onInit(_event: InitEvent): Promise<void> {}
@@ -97,20 +99,37 @@ export abstract class Applet<State extends object> {
     this.register("toggle", id, handler as Handler<CallbackEvent>);
   }
 
+  onPopover(handler: Handler<PopoverEvent>): void {
+    this.register("open", "popover", handler as Handler<CallbackEvent>);
+    this.register("close", "popover", handler as Handler<CallbackEvent>);
+  }
+
   isPopoverOpen(): boolean {
     return this.popoverOpen;
   }
 
-  protected showNotification(args: ShowNotificationArgs): void {
-    this.emitAction("show_notification", args);
+  log(...args: unknown[]): void {
+    process.stderr.write(args.map(String).join(" ") + "\n");
   }
 
-  protected openUri(args: OpenUriArgs): void {
-    this.emitAction("open_uri", args);
+  protected async showNotification(summary: string, options: ShowNotificationOptions = {}): Promise<void> {
+    const args = [summary];
+    if (options.body !== undefined) {
+      args.push(options.body);
+    }
+    await this.runDesktopCommand("notify-send", args);
   }
 
-  protected copyToClipboard(args: CopyToClipboardArgs): void {
-    this.emitAction("copy_to_clipboard", args);
+  protected async openUri(uri: string): Promise<void> {
+    await this.runDesktopCommand("xdg-open", [uri]);
+  }
+
+  protected async copyToClipboard(text: string): Promise<void> {
+    await this.runDesktopCommand("wl-copy", [], text);
+  }
+
+  protected async runCommand(command: string[]): Promise<CommandResult> {
+    return await runCommand(command);
   }
 
   protected dismissNotification(args: DismissNotificationArgs): void {
@@ -121,6 +140,10 @@ export abstract class Applet<State extends object> {
     this.emitAction("close_popover", {});
   }
 
+  protected async runDesktopCommand(command: string, args: string[], input?: string): Promise<void> {
+    await runDesktopCommand([command, ...args], input);
+  }
+
   async run(): Promise<void> {
     process.stdout.on("error", (err: NodeJS.ErrnoException) => {
       if (err.code === "EPIPE") {
@@ -129,6 +152,10 @@ export abstract class Applet<State extends object> {
     });
 
     await this.onStart();
+    const cssClass = this.cssClass();
+    if (cssClass !== null) {
+      process.stdout.write(`class ${cssClass}\n`);
+    }
     await this.scheduleRender();
 
     const rl = createInterface({
@@ -171,7 +198,13 @@ export abstract class Applet<State extends object> {
   }
 
   private async dispatchCallback(event: CallbackEvent): Promise<void> {
-    const handler = this.handlerMap.get(`${event.event}:${event.id}`);
+    const key = `${event.event}:${event.id}`;
+    const inlineHandler = this.inlineHandlerMap.get(key);
+    if (inlineHandler !== undefined) {
+      await inlineHandler(event);
+      return;
+    }
+    const handler = this.handlerMap.get(key);
     if (handler !== undefined) {
       await handler(event);
       return;
@@ -221,6 +254,13 @@ export abstract class Applet<State extends object> {
     }
 
     const widget = await this.popover(this.state);
+    if (widget !== null) {
+      const registry = new InlineHandlerRegistry();
+      widget.bindHandlers?.(registry, []);
+      this.inlineHandlerMap = registry.handlers;
+    } else {
+      this.inlineHandlerMap = new Map();
+    }
     const tree = { root: widget?.toProtocol() ?? null };
     if (!deepEqual(tree, this.lastTree)) {
       this.lastTree = tree;
@@ -268,3 +308,40 @@ function deepEqual(left: unknown, right: unknown): boolean {
 function isPopoverEvent(event: CallbackEvent): event is PopoverEvent {
   return event.event === "open" || event.event === "close";
 }
+
+export async function runCommand(command: string[]): Promise<CommandResult> {
+  return await runCommandWithInput(command);
+}
+
+async function runDesktopCommand(command: string[], input?: string): Promise<void> {
+  const result = await runCommandWithInput(command, input);
+  if (result.rc !== 0) {
+    throw new Error(`${command[0]} exited with status ${result.rc}`);
+  }
+}
+
+async function runCommandWithInput(command: string[], input?: string): Promise<CommandResult> {
+  if (command.length === 0) {
+    throw new Error("command must not be empty");
+  }
+  return await new Promise<CommandResult>((resolve, reject) => {
+    const child = spawn(command[0], command.slice(1), { stdio: ["pipe", "pipe", "pipe"] });
+    const stdout: Buffer[] = [];
+    const stderr: Buffer[] = [];
+    child.on("error", reject);
+    child.stdout.on("data", (chunk: Buffer) => stdout.push(chunk));
+    child.stderr.on("data", (chunk: Buffer) => stderr.push(chunk));
+    child.on("close", (code) => {
+      resolve({
+        stdout: Buffer.concat(stdout).toString("utf8"),
+        stderr: Buffer.concat(stderr).toString("utf8"),
+        rc: code ?? -1,
+      });
+    });
+    if (input !== undefined) {
+      child.stdin.end(input);
+    } else {
+      child.stdin.end();
+    }
+  });
+}

package/src/events.ts

@@ -10,7 +10,7 @@ interface CallbackEventBase {
 
 export interface ClickEvent extends CallbackEventBase {
   event: "click";
-  button?: string;
+  button?: string | null;
 }
 
 export interface ScrollEvent extends CallbackEventBase {
@@ -57,7 +57,7 @@ export function parseCallbackEvent(payload: Record<string, unknown>): CallbackEv
   const event = String(payload.type ?? payload.event ?? "");
   const id = String(payload.id ?? "");
   if (event === "click") {
-    return { id, event, button: payload.button === undefined ? undefined : String(payload.button) };
+    return { id, event, button: payload.button === undefined ? null : String(payload.button) };
   }
   if (event === "scroll") {
     return {

package/src/index.ts

@@ -1,4 +1,4 @@
-export { Applet } from "./app.js";
+export { Applet, runCommand } from "./app.js";
 export {
   type CallbackEvent,
   type ChangeEvent,
@@ -11,55 +11,58 @@ export {
   parseCallbackEvent,
   parseInitEvent,
 } from "./events.js";
-export { Icon, StatusItem } from "./protocol.js";
-export { type Event, IpcError, Subscriber, ipc } from "./ipc.js";
+export { ipc, IpcError, Subscriber } from "./ipc.js";
+export { StatusItem } from "./protocol.js";
 export {
-  ActionItem,
-  type Align,
   Badge,
-  Box,
-  Button,
-  type ButtonVariant,
-  Card,
-  Checkbox,
+  type BadgeKind,
+  BatteryHero,
+  BoxedList,
+  ButtonRow,
+  Calendar,
+  CameraIndicator,
+  Choice,
+  ChoiceList,
+  ChoiceTile,
+  CircleBox,
   Column,
-  type ContentFit,
-  Copyable,
+  Container,
+  DateHero,
   EmptyState,
-  Expander,
-  Grid,
-  GridChild,
+  EventItem,
+  Events,
+  ExpanderTile,
+  Header,
   Hero,
-  Image,
-  Item,
+  KeyValueGrid,
   Label,
-  LevelBar,
-  type LevelBarMode,
-  LinkButton,
-  ListBox,
-  MenuButton,
+  LocationIndicator,
   Meter,
-  Overlay,
-  type Orientation,
+  MicIndicator,
+  MutedIndicator,
   type PagerAppearance,
   PagerItem,
   PagerStrip,
-  Picture,
-  Progress,
-  type Properties,
-  PropertyList,
+  PanelIndicator,
+  PopoverShell,
+  type PopoverSize,
   Row,
+  ScreenCastIndicator,
   Scroll,
-  Section,
-  Select,
-  SelectOption,
+  SegmentedTile,
   Separator,
-  Slider,
+  SliderTile,
   Spinner,
   StatusDot,
-  Switch,
-  ToggleButton,
-  TreeExpander,
+  type StatusDotStatus,
+  SwitchTile,
+  Tile,
   type TreeNode,
-  type Variant,
+  WeatherForecastItem,
+  WeatherForecastList,
+  WeatherHourlyItem,
+  WeatherHourlyStrip,
+  WidgetBase,
+  WorldClock,
+  WorldClockRow,
 } from "./widgets.js";

package/src/protocol.ts

@@ -1,29 +1,8 @@
-export type IconKind = "name" | "path";
-
-export class Icon {
-  constructor(
-    public readonly kind: IconKind,
-    public readonly value: string,
-  ) {}
-
-  static name(value: string): Icon {
-    return new Icon("name", value);
-  }
-
-  static path(value: string): Icon {
-    return new Icon("path", value);
-  }
-
-  toProtocol(): { name: string } | { path: string } {
-    return this.kind === "name" ? { name: this.value } : { path: this.value };
-  }
-}
-
 export class StatusItem {
   constructor(
     public readonly options: {
       id?: string;
-      icon?: Icon;
+      icon?: string;
       label?: string;
       tooltip?: string;
     } = {},
@@ -35,7 +14,7 @@ export class StatusItem {
       payload.id = this.options.id;
     }
     if (this.options.icon !== undefined) {
-      payload.icon = this.options.icon.toProtocol();
+      payload.icon = this.options.icon;
     }
     if (this.options.label !== undefined) {
       payload.label = this.options.label;