@frockbot/plugin-desktop-directory-picker 0.0.0 → 0.1.1

package/frockbot.json

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

package/package.json

@@ -1,14 +1,36 @@
 {
   "name": "@frockbot/plugin-desktop-directory-picker",
-  "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-directory-picker"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

package/src/desktop.test.ts

@@ -0,0 +1,122 @@
+import { afterEach, describe, expect, test } from "bun:test";
+import {
+  DesktopCommandRegistry,
+  DesktopDirectoryPickerCapability,
+  type DesktopDirectoryPickerRequest,
+  type DesktopDirectoryPickerResult,
+} from "@frockbot/desktop-core";
+import { Context } from "cordis";
+import {
+  desktopDirectoryPickerPlugin,
+  PICK_DIRECTORY_COMMAND,
+} from "./desktop.js";
+
+class FakeDirectoryPicker extends DesktopDirectoryPickerCapability {
+  requests: DesktopDirectoryPickerRequest[] = [];
+  result: DesktopDirectoryPickerResult = {
+    paths: ["/tmp/frockbot"],
+    cancelled: false,
+  };
+
+  pick(
+    request: DesktopDirectoryPickerRequest,
+    signal: AbortSignal,
+  ): Promise<DesktopDirectoryPickerResult> {
+    signal.throwIfAborted();
+    this.requests.push(request);
+    return Promise.resolve(this.result);
+  }
+}
+
+const roots: Context[] = [];
+
+async function createHost(): Promise<{
+  root: Context;
+  picker: FakeDirectoryPicker;
+}> {
+  const root = new Context();
+  roots.push(root);
+  await root.plugin(DesktopCommandRegistry);
+  await root.plugin(FakeDirectoryPicker);
+  return {
+    root,
+    picker: root.desktopDirectoryPicker as FakeDirectoryPicker,
+  };
+}
+
+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 directory picker plugin", () => {
+  test("registers a directory command backed by the granted capability", async () => {
+    const { root, picker } = await createHost();
+    await root.plugin(desktopDirectoryPickerPlugin);
+
+    expect(
+      await root.desktopCommands.invoke<DesktopDirectoryPickerResult>(
+        PICK_DIRECTORY_COMMAND,
+        { title: " Choose a workspace ", multiple: true },
+      ),
+    ).toEqual({ paths: ["/tmp/frockbot"], cancelled: false });
+    expect(picker.requests).toEqual([
+      {
+        mode: "directory",
+        title: "Choose a workspace",
+        multiple: true,
+      },
+    ]);
+  });
+
+  test("preserves cancellation as an ordinary capability result", async () => {
+    const { root, picker } = await createHost();
+    picker.result = { paths: [], cancelled: true };
+    await root.plugin(desktopDirectoryPickerPlugin);
+
+    expect(
+      await root.desktopCommands.invoke<DesktopDirectoryPickerResult>(
+        PICK_DIRECTORY_COMMAND,
+        {},
+      ),
+    ).toEqual({ paths: [], cancelled: true });
+  });
+
+  test("unregisters its command on disposal", async () => {
+    const { root } = await createHost();
+    const fiber = await root.plugin(desktopDirectoryPickerPlugin);
+
+    await fiber.dispose();
+
+    await expectFailure(
+      root.desktopCommands.invoke(PICK_DIRECTORY_COMMAND, {}),
+      "is unavailable",
+    );
+  });
+
+  test("rejects malformed input before invoking the capability", async () => {
+    const { root, picker } = await createHost();
+    await root.plugin(desktopDirectoryPickerPlugin);
+
+    await expectFailure(
+      root.desktopCommands.invoke(PICK_DIRECTORY_COMMAND, {
+        multiple: "yes",
+      }),
+      "directory picker multiple must be a boolean",
+    );
+    expect(picker.requests).toEqual([]);
+  });
+});

package/src/desktop.ts

@@ -0,0 +1,60 @@
+import type {
+  DesktopCommand,
+  DesktopDirectoryPickerResult,
+} from "@frockbot/desktop-core";
+import type { Plugin } from "cordis";
+
+export const PICK_DIRECTORY_COMMAND = "desktop.directory.pick";
+
+export interface PickDirectoryInput {
+  title?: string;
+  multiple?: boolean;
+}
+
+export function decodePickDirectoryInput(input: unknown): PickDirectoryInput {
+  if (typeof input !== "object" || input === null || Array.isArray(input)) {
+    throw new Error("directory picker input must be an object");
+  }
+  const record = input as Record<string, unknown>;
+  let title: string | undefined;
+  if (record.title !== undefined) {
+    if (typeof record.title !== "string") {
+      throw new Error("directory picker title must be a string");
+    }
+    title = record.title.trim() || undefined;
+    if (title && title.length > 200) {
+      throw new Error("directory picker title must be at most 200 characters");
+    }
+  }
+  const multiple = record.multiple ?? false;
+  if (typeof multiple !== "boolean") {
+    throw new Error("directory picker multiple must be a boolean");
+  }
+  return { title, multiple };
+}
+
+export const desktopDirectoryPickerPlugin: Plugin.Function = (ctx) => {
+  const command: DesktopCommand<
+    PickDirectoryInput,
+    DesktopDirectoryPickerResult
+  > = {
+    id: PICK_DIRECTORY_COMMAND,
+    decode: decodePickDirectoryInput,
+    execute: (input, context) =>
+      ctx.desktopDirectoryPicker.pick(
+        {
+          mode: "directory",
+          title: input.title,
+          multiple: input.multiple ?? false,
+        },
+        context.signal,
+      ),
+  };
+  return ctx.desktopCommands.register(command);
+};
+desktopDirectoryPickerPlugin.inject = [
+  "desktopCommands",
+  "desktopDirectoryPicker",
+];
+
+export default desktopDirectoryPickerPlugin;

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./desktop.js";
+export { default as desktopDirectoryPickerManifest } 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-directory-picker
-
-Placeholder reserving this name. See https://github.com/timoconnellaus/frockbot.