@frockbot/plugin-desktop-notifications 0.0.0 → 0.1.1

package/frockbot.json

@@ -0,0 +1,15 @@
+{
+  "schemaVersion": 3,
+  "id": "desktop-notifications",
+  "displayName": "Desktop Notifications",
+  "version": "0.0.1",
+  "compatibility": { "frockbot": ">=0.0.1" },
+  "contributions": {
+    "desktop": {
+      "entry": "./desktop",
+      "execution": "trusted-main",
+      "commands": []
+    }
+  },
+  "permissions": ["desktop:notifications"]
+}

package/package.json

@@ -1,14 +1,36 @@
 {
   "name": "@frockbot/plugin-desktop-notifications",
-  "version": "0.0.0",
-  "description": "Placeholder reserving this name for trusted publishing. Superseded by the first release.",
-  "license": "UNLICENSED",
+  "version": "0.1.1",
+  "private": false,
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts",
+    "./desktop": "./src/desktop.ts",
+    "./manifest": "./src/manifest.ts",
+    "./frockbot.json": "./frockbot.json",
+    "./package.json": "./package.json"
+  },
+  "frockbot": {
+    "manifest": "./frockbot.json"
+  },
+  "scripts": {
+    "test": "bun test src",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  },
+  "dependencies": {
+    "@frockbot/desktop-core": "0.1.1",
+    "cordis": "4.0.0-rc.8"
+  },
+  "devDependencies": {
+    "@types/bun": "1.4.0",
+    "typescript": "^7.0.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/timoconnellaus/frockbot.git",
     "directory": "packages/plugin-desktop-notifications"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

package/src/desktop.test.ts

@@ -0,0 +1,105 @@
+import { afterEach, describe, expect, test } from "bun:test";
+import {
+  DesktopCommandRegistry,
+  DesktopNotificationCapability,
+  type DesktopNotificationRequest,
+} from "@frockbot/desktop-core";
+import { Context } from "cordis";
+import {
+  desktopNotificationsPlugin,
+  SHOW_NOTIFICATION_COMMAND,
+  type ShowNotificationResult,
+} from "./desktop.js";
+
+class FakeNotifications extends DesktopNotificationCapability {
+  requests: DesktopNotificationRequest[] = [];
+
+  show(
+    request: DesktopNotificationRequest,
+    signal: AbortSignal,
+  ): Promise<void> {
+    signal.throwIfAborted();
+    this.requests.push(request);
+    return Promise.resolve();
+  }
+}
+
+const roots: Context[] = [];
+
+async function createHost(): Promise<{
+  root: Context;
+  notifications: FakeNotifications;
+}> {
+  const root = new Context();
+  roots.push(root);
+  await root.plugin(DesktopCommandRegistry);
+  await root.plugin(FakeNotifications);
+  return {
+    root,
+    notifications: root.desktopNotifications as FakeNotifications,
+  };
+}
+
+afterEach(async () => {
+  await Promise.all(roots.splice(0).map((root) => root.fiber.dispose()));
+});
+
+async function expectFailure(
+  promise: Promise<unknown>,
+  message: string,
+): Promise<void> {
+  let failure: unknown;
+  try {
+    await promise;
+  } catch (error) {
+    failure = error;
+  }
+  expect(failure).toBeInstanceOf(Error);
+  expect(failure instanceof Error ? failure.message : "").toContain(message);
+}
+
+describe("desktop notifications plugin", () => {
+  test("registers a command backed by the granted capability", async () => {
+    const { root, notifications } = await createHost();
+    await root.plugin(desktopNotificationsPlugin);
+
+    expect(
+      await root.desktopCommands.invoke<ShowNotificationResult>(
+        SHOW_NOTIFICATION_COMMAND,
+        { title: " Turn complete ", body: " FrockBot is idle " },
+      ),
+    ).toEqual({ shown: true });
+    expect(notifications.requests).toEqual([
+      {
+        title: "Turn complete",
+        body: "FrockBot is idle",
+        urgency: "normal",
+      },
+    ]);
+  });
+
+  test("unregisters its command when its fiber is disposed", async () => {
+    const { root } = await createHost();
+    const fiber = await root.plugin(desktopNotificationsPlugin);
+
+    await fiber.dispose();
+
+    await expectFailure(
+      root.desktopCommands.invoke(SHOW_NOTIFICATION_COMMAND, {
+        title: "Not delivered",
+      }),
+      "is unavailable",
+    );
+  });
+
+  test("rejects malformed input before invoking the capability", async () => {
+    const { root, notifications } = await createHost();
+    await root.plugin(desktopNotificationsPlugin);
+
+    await expectFailure(
+      root.desktopCommands.invoke(SHOW_NOTIFICATION_COMMAND, { title: " " }),
+      "notification title is required",
+    );
+    expect(notifications.requests).toEqual([]);
+  });
+});

package/src/desktop.ts

@@ -0,0 +1,71 @@
+import type {
+  DesktopCommand,
+  DesktopNotificationRequest,
+} from "@frockbot/desktop-core";
+import type { Plugin } from "cordis";
+
+export const SHOW_NOTIFICATION_COMMAND = "desktop.notifications.show";
+
+export interface ShowNotificationInput {
+  title: string;
+  body?: string;
+  urgency?: "normal" | "critical";
+}
+
+export interface ShowNotificationResult {
+  shown: true;
+}
+
+function optionalString(
+  record: Record<string, unknown>,
+  key: string,
+  maxLength: number,
+): string | undefined {
+  const value = record[key];
+  if (value === undefined) return undefined;
+  if (typeof value !== "string") throw new Error(`${key} must be a string`);
+  const normalized = value.trim();
+  if (!normalized) return undefined;
+  if (normalized.length > maxLength) {
+    throw new Error(`${key} must be at most ${maxLength} characters`);
+  }
+  return normalized;
+}
+
+export function decodeShowNotificationInput(
+  input: unknown,
+): ShowNotificationInput {
+  if (typeof input !== "object" || input === null || Array.isArray(input)) {
+    throw new Error("notification input must be an object");
+  }
+  const record = input as Record<string, unknown>;
+  const title = optionalString(record, "title", 200);
+  if (!title) throw new Error("notification title is required");
+  const body = optionalString(record, "body", 4_096);
+  const urgency = record.urgency ?? "normal";
+  if (urgency !== "normal" && urgency !== "critical") {
+    throw new Error('notification urgency must be "normal" or "critical"');
+  }
+  return { title, body, urgency };
+}
+
+export const desktopNotificationsPlugin: Plugin.Function = (ctx) => {
+  const command: DesktopCommand<ShowNotificationInput, ShowNotificationResult> =
+    {
+      id: SHOW_NOTIFICATION_COMMAND,
+      decode: decodeShowNotificationInput,
+      async execute(input, context): Promise<ShowNotificationResult> {
+        const request: DesktopNotificationRequest = {
+          title: input.title,
+          body: input.body,
+          urgency: input.urgency ?? "normal",
+        };
+        await ctx.desktopNotifications.show(request, context.signal);
+        return { shown: true };
+      },
+    };
+  return ctx.desktopCommands.register(command);
+};
+desktopNotificationsPlugin.inject = ["desktopCommands", "desktopNotifications"];
+
+export default desktopNotificationsPlugin;

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./desktop.js";
+export { default as desktopNotificationsManifest } from "./manifest.js";

package/src/manifest.ts

@@ -0,0 +1,3 @@
+import manifest from "../frockbot.json" with { type: "json" };
+
+export default manifest;

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2023",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true,
+    "noEmit": true,
+    "skipLibCheck": true,
+    "lib": ["ES2023", "DOM"],
+    "types": ["bun"]
+  },
+  "include": ["src/**/*.ts"]
+}

package/README.md

@@ -1,3 +0,0 @@
-# @frockbot/plugin-desktop-notifications
-
-Placeholder reserving this name. See https://github.com/timoconnellaus/frockbot.