@flowscripter/dynamic-plugin-framework 1.3.18 → 1.4.0

package/.github/workflows/release-bun-library.yml

@@ -8,6 +8,7 @@ permissions:
   pull-requests: write
   id-token: write
   pages: write
+  packages: write
 jobs:
   call-release-bun-library:
     uses: flowscripter/.github/.github/workflows/release-bun-library.yml@v1

package/README.md

@@ -9,7 +9,7 @@
 > Dynamic plugin framework for Bun based on Javascript Modules and import()
 > function
 
-[//]: # (TODO: Remove this when plugin indexing and discovery available.)
+[//]: # "TODO: Remove this when plugin indexing and discovery available."
 
 **STILL IN DEVELOPMENT**
 
@@ -242,20 +242,17 @@ Test:
 
 `bun test`
 
-**NOTE**: The following tasks use Deno as it excels at these and Bun does not
-currently provide such functionality:
-
 Format:
 
-`deno fmt`
+`bunx oxfmt`
 
 Lint:
 
-`deno lint index.ts src/ tests/`
+`bunx oxlint index.ts src/ tests/`
 
 Generate HTML API Documentation:
 
-`deno doc --html --name=dynamic-plugin-framework index.ts`
+`bunx typedoc --readme none index.ts`
 
 The following diagram provides an overview of the main internal classes:
 

package/bun.lock

@@ -1,26 +1,25 @@
 {
   "lockfileVersion": 1,
+  "configVersion": 0,
   "workspaces": {
     "": {
       "name": "@flowscripter/dynamic-plugin-framework",
       "devDependencies": {
-        "@types/bun": "^1.2.9",
+        "@types/bun": "^1.3.14",
       },
       "peerDependencies": {
-        "typescript": "^5.8.3",
+        "typescript": "^6.0.3",
       },
     },
   },
   "packages": {
-    "@types/bun": ["@types/bun@1.2.9", "", { "dependencies": { "bun-types": "1.2.9" } }, "sha512-epShhLGQYc4Bv/aceHbmBhOz1XgUnuTZgcxjxk+WXwNyDXavv5QHD1QEFV0FwbTSQtNq6g4ZcV6y0vZakTjswg=="],
+    "@types/bun": ["@types/bun@1.3.14", "", { "dependencies": { "bun-types": "1.3.14" } }, "sha512-h1hFqFVcvAvD9j9K7ZW7vd82aSA+rTdznZa+5bwvCwqSB1jmmfLcbIWhOLx1/+boy/xmjgCs/OMUL8hRJSmnPw=="],
 
     "@types/node": ["@types/node@22.13.4", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-ywP2X0DYtX3y08eFVx5fNIw7/uIv8hYUKgXoK8oayJlLnKcRfEYCxWMVE1XagUdVtCJlZT1AU4LXEABW+L1Peg=="],
 
-    "@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw=="],
+    "bun-types": ["bun-types@1.3.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-4N0ig0fEomHt5R0KCFWjovxow98rIoRwKolrYdCcknNwMekCXRnWEUvgu5soYV8QXtVsrUD8B95MBOZGPvr6KQ=="],
 
-    "bun-types": ["bun-types@1.2.9", "", { "dependencies": { "@types/node": "*", "@types/ws": "*" } }, "sha512-dk/kOEfQbajENN/D6FyiSgOKEuUi9PWfqKQJEgwKrCMWbjS/S6tEXp178mWvWAcUSYm9ArDlWHZKO3T/4cLXiw=="],
-
-    "typescript": ["typescript@5.8.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ=="],
+    "typescript": ["typescript@6.0.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw=="],
 
     "undici-types": ["undici-types@6.20.0", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
   }

package/package.json

@@ -1,29 +1,29 @@
 {
   "name": "@flowscripter/dynamic-plugin-framework",
+  "version": "1.4.0",
   "description": "Dynamic plugin framework for Bun based on Javascript Modules and import() function",
+  "keywords": [
+    "bun",
+    "dynamic",
+    "framework",
+    "import",
+    "plugin"
+  ],
   "homepage": "https://github.com/flowscripter/dynamic-plugin-framework#readme",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/flowscripter/dynamic-plugin-framework.git"
   },
-  "license": "MIT",
-  "keywords": [
-    "bun",
-    "plugin",
-    "framework",
-    "dynamic",
-    "import"
-  ],
-  "module": "index.ts",
   "type": "module",
-  "version": "1.3.18",
+  "module": "index.ts",
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@types/bun": "^1.2.9"
+    "@types/bun": "^1.3.14"
   },
   "peerDependencies": {
-    "typescript": "^5.8.3"
+    "typescript": "^6.0.3"
   }
 }

package/src/api/plugin_manager/PluginManager.ts

@@ -18,9 +18,7 @@ export default interface PluginManager {
    *
    * @return array of {@link ExtensionInfo}
    */
-  getRegisteredExtensions(
-    extensionPoint: string,
-  ): Promise<ReadonlyArray<ExtensionInfo>>;
+  getRegisteredExtensions(extensionPoint: string): Promise<ReadonlyArray<ExtensionInfo>>;
 
   /**
    * Instantiate a specific Extension.
@@ -31,8 +29,5 @@ export default interface PluginManager {
    *
    * @return an Extension instance implementing an Extension Point.
    */
-  instantiate(
-    extensionHandle: string,
-    hostData?: Map<string, string>,
-  ): Promise<unknown>;
+  instantiate(extensionHandle: string, hostData?: Map<string, string>): Promise<unknown>;
 }

package/src/plugin_manager/DefaultPluginManager.ts

@@ -12,30 +12,25 @@ import type PluginRepository from "./plugin_repository/PluginRepository.ts";
 export default class DefaultPluginManager implements PluginManager {
   private readonly extensionPointRegistry: ExtensionPointRegistry;
   private readonly extensionRegistry: ExtensionRegistry;
-  private readonly pluginRepositoriesByExtensionHandle = new Map<
-    string,
-    PluginRepository
-  >();
+  private readonly pluginRepositoriesByExtensionHandle = new Map<string, PluginRepository>();
 
   /**
    * Constructor configures the instance using the optionally specified
    * {@link ExtensionPointRegistry} and {@link ExtensionRegistry}.
    *
    * @param pluginRepositories One or more {@link PluginRepository} instances to use for plugin discovery.
-   * @param extensionPointRegistry optional {@link ExtensionPointRegistry]] implementation. Defaults to using
-   * {@link InMemoryExtensionPointRegistry}.
+   * @param extensionPointRegistry optional {@link ExtensionPointRegistry} implementation. Defaults to using
+   * InMemoryExtensionPointRegistry.
    * @param extensionRegistry optional {@link ExtensionRegistry} implementation. Defaults to using
-   * {@link InMemoryExtensionRegistry}
+   * InMemoryExtensionRegistry
    */
   public constructor(
     private readonly pluginRepositories: Array<PluginRepository>,
     extensionPointRegistry?: ExtensionPointRegistry,
     extensionRegistry?: ExtensionRegistry,
   ) {
-    this.extensionPointRegistry = extensionPointRegistry ||
-      new InMemoryExtensionPointRegistry();
-    this.extensionRegistry = extensionRegistry ||
-      new InMemoryExtensionRegistry();
+    this.extensionPointRegistry = extensionPointRegistry || new InMemoryExtensionPointRegistry();
+    this.extensionRegistry = extensionRegistry || new InMemoryExtensionRegistry();
   }
 
   public async registerExtensions(extensionPoint: string): Promise<void> {
@@ -47,18 +42,10 @@ export default class DefaultPluginManager implements PluginManager {
 
     for (let i = 0; i < this.pluginRepositories.length; i++) {
       const pluginRepository = this.pluginRepositories[i];
-      for await (
-        const extensionEntry of pluginRepository.scanForExtensions(
-          extensionPoint,
-        )
-      ) {
-        const extensionHandle =
-          `${i}:${extensionEntry.pluginId}:${extensionEntry.extensionId}`;
+      for await (const extensionEntry of pluginRepository.scanForExtensions(extensionPoint)) {
+        const extensionHandle = `${i}:${extensionEntry.pluginId}:${extensionEntry.extensionId}`;
 
-        this.pluginRepositoriesByExtensionHandle.set(
-          extensionHandle,
-          pluginRepository,
-        );
+        this.pluginRepositoriesByExtensionHandle.set(extensionHandle, pluginRepository);
         await this.extensionRegistry.register(extensionHandle, extensionEntry);
       }
     }
@@ -67,9 +54,7 @@ export default class DefaultPluginManager implements PluginManager {
   public async getRegisteredExtensions(
     extensionPoint: string,
   ): Promise<ReadonlyArray<ExtensionInfo>> {
-    const extensionMap = await this.extensionRegistry.getExtensions(
-      extensionPoint,
-    );
+    const extensionMap = await this.extensionRegistry.getExtensions(extensionPoint);
     const registeredExtensions = new Array<ExtensionInfo>();
 
     extensionMap.forEach((entry, handle) => {
@@ -96,16 +81,14 @@ export default class DefaultPluginManager implements PluginManager {
     const extensionEntry = await this.extensionRegistry.get(extensionHandle);
 
     // Get the Plugin Repository for the Extension Handle
-    const pluginRepository = this.pluginRepositoriesByExtensionHandle.get(
-      extensionHandle,
-    );
+    const pluginRepository = this.pluginRepositoriesByExtensionHandle.get(extensionHandle);
 
     if (!pluginRepository) {
       return Promise.reject(`Extension handle ${extensionHandle} is unknown`);
     }
     // Get the Extension Descriptor from the Plugin Repository
-    const extensionDescriptor = await pluginRepository
-      .getExtensionDescriptorFromExtensionEntry(extensionEntry);
+    const extensionDescriptor =
+      await pluginRepository.getExtensionDescriptorFromExtensionEntry(extensionEntry);
 
     return extensionDescriptor.factory.create(hostData);
   }

package/src/plugin_manager/plugin_repository/PluginRepository.ts

@@ -13,14 +13,12 @@ export default interface PluginRepository {
    *
    * @return an async iterable of {@link ExtensionEntry} instances for all matching Extensions.
    */
-  scanForExtensions(
-    extensionPoint: string,
-  ): AsyncIterable<Readonly<ExtensionEntry>>;
+  scanForExtensions(extensionPoint: string): AsyncIterable<Readonly<ExtensionEntry>>;
 
   /**
    * Return the {@link ExtensionDescriptor} for the Extension identified by the specified {@link ExtensionEntry}.
    *
-   * @param extensionEntry the {@link extensionEntry} for the desired Extension.
+   * @param extensionEntry the {@link ExtensionEntry} for the desired Extension.
    *
    * @return an {@link ExtensionDescriptor} instance.
    */

package/src/plugin_manager/plugin_repository/UrlListPluginRepository.ts

@@ -18,28 +18,22 @@ export default class UrlListPluginRepository implements PluginRepository {
    * @throws *Error* if the URL set contains a non-valid URL.
    */
   public constructor(
-    private readonly urlsAndExtensionPoints: Set<
-      { url: string; extensionPoints: string[] }
-    >,
+    private readonly urlsAndExtensionPoints: Set<{ url: string; extensionPoints: string[] }>,
   ) {
-    if (!urlsAndExtensionPoints || (urlsAndExtensionPoints.size === 0)) {
-      throw new Error(
-        `Undefined or empty set of URL and extension points provided`,
-      );
+    if (!urlsAndExtensionPoints || urlsAndExtensionPoints.size === 0) {
+      throw new Error(`Undefined or empty set of URL and extension points provided`);
     }
     this.urlsAndExtensionPoints.forEach((urlAndExtensionPoint) => {
       try {
         new URL(urlAndExtensionPoint.url);
       } catch (err) {
         throw new Error(
-          `Cannot parse ${urlAndExtensionPoint.url} as a URL: ${
-            (err as Error).message
-          }`,
+          `Cannot parse ${urlAndExtensionPoint.url} as a URL: ${(err as Error).message}`,
         );
       }
       if (
         !urlAndExtensionPoint.extensionPoints ||
-        (urlAndExtensionPoint.extensionPoints.length === 0)
+        urlAndExtensionPoint.extensionPoints.length === 0
       ) {
         throw new Error(`Undefined or empty set of extension points provided`);
       }
@@ -54,9 +48,7 @@ export default class UrlListPluginRepository implements PluginRepository {
       if (!urlAndExtensionPoints.extensionPoints.includes(extensionPoint)) {
         continue;
       }
-      const plugin = await this.pluginSource.loadPlugin(
-        new URL(urlAndExtensionPoints.url),
-      );
+      const plugin = await this.pluginSource.loadPlugin(new URL(urlAndExtensionPoints.url));
 
       if (plugin) {
         // Once we have loaded the plugin, double check on the extension points in the plugin
@@ -79,9 +71,7 @@ export default class UrlListPluginRepository implements PluginRepository {
     }
   }
 
-  public scanForExtensions(
-    extensionPoint: string,
-  ): AsyncIterable<ExtensionEntry> {
+  public scanForExtensions(extensionPoint: string): AsyncIterable<ExtensionEntry> {
     return this.getExtensionEntryAsyncIterable(extensionPoint);
   }
 
@@ -93,9 +83,7 @@ export default class UrlListPluginRepository implements PluginRepository {
   public async getExtensionDescriptorFromExtensionEntry(
     extensionEntry: ExtensionEntry,
   ): Promise<Readonly<ExtensionDescriptor>> {
-    const plugin = await this.pluginSource.loadPlugin(
-      new URL(extensionEntry.pluginId),
-    );
+    const plugin = await this.pluginSource.loadPlugin(new URL(extensionEntry.pluginId));
 
     if (!plugin) {
       return Promise.reject(`Plugin ID ${extensionEntry.pluginId} is unknown`);
@@ -106,17 +94,11 @@ export default class UrlListPluginRepository implements PluginRepository {
     try {
       extensionId = parseInt(extensionEntry.extensionId);
     } catch (_e) {
-      return Promise.reject(
-        `Extension ID ${extensionEntry.extensionId} is unknown`,
-      );
+      return Promise.reject(`Extension ID ${extensionEntry.extensionId} is unknown`);
     }
 
-    if (
-      (extensionId < 0) || (extensionId >= plugin.extensionDescriptors.length)
-    ) {
-      return Promise.reject(
-        `Extension ID ${extensionEntry.extensionId} is unknown`,
-      );
+    if (extensionId < 0 || extensionId >= plugin.extensionDescriptors.length) {
+      return Promise.reject(`Extension ID ${extensionEntry.extensionId} is unknown`);
     }
 
     return Promise.resolve(plugin.extensionDescriptors[extensionId]);

package/src/plugin_manager/plugin_repository/UrlPluginSource.ts

@@ -21,17 +21,12 @@ export default class UrlPluginSource {
 
     if (!plugin) {
       const pluginLoadResult = await loadPlugin(url.toString());
-      if (
-        pluginLoadResult.isValidPlugin &&
-        (pluginLoadResult.plugin !== undefined)
-      ) {
+      if (pluginLoadResult.isValidPlugin && pluginLoadResult.plugin !== undefined) {
         plugin = pluginLoadResult.plugin;
         this.pluginsByUrl.set(url, plugin);
       }
       if (pluginLoadResult.error) {
-        throw new Error(
-          `Failed to load plugin from ${url}: ${pluginLoadResult.error.message}`,
-        );
+        throw new Error(`Failed to load plugin from ${url}: ${pluginLoadResult.error.message}`);
       }
     }
     return Promise.resolve(this.pluginsByUrl.get(url));

package/src/plugin_manager/registry/ExtensionRegistry.ts

@@ -10,10 +10,7 @@ export default interface ExtensionRegistry {
    * @param extensionHandle a unique identifier under which to register the {@link ExtensionEntry}
    * @param extensionEntry the {@link ExtensionEntry} for the Extension to register
    */
-  register(
-    extensionHandle: string,
-    extensionEntry: ExtensionEntry,
-  ): Promise<void>;
+  register(extensionHandle: string, extensionEntry: ExtensionEntry): Promise<void>;
 
   /**
    * Return the specified registered {@link ExtensionEntry} instance.
@@ -32,7 +29,5 @@ export default interface ExtensionRegistry {
    * @return a map of extension handle to {@link ExtensionEntry} for all matching
    * registered {@link ExtensionEntry} instances
    */
-  getExtensions(
-    extensionPoint: string,
-  ): Promise<ReadonlyMap<string, ExtensionEntry>>;
+  getExtensions(extensionPoint: string): Promise<ReadonlyMap<string, ExtensionEntry>>;
 }

package/src/plugin_manager/registry/InMemoryExtensionPointRegistry.ts

@@ -3,8 +3,7 @@ import type ExtensionPointRegistry from "./ExtensionPointRegistry.ts";
 /**
  * Simple implementation of an {@link ExtensionPointRegistry} using an in-memory Set.
  */
-export default class InMemoryExtensionPointRegistry
-  implements ExtensionPointRegistry {
+export default class InMemoryExtensionPointRegistry implements ExtensionPointRegistry {
   private readonly extensionPoints: Set<string> = new Set();
 
   /**

package/src/plugin_manager/registry/InMemoryExtensionRegistry.ts

@@ -5,40 +5,27 @@ import type ExtensionEntry from "../plugin_repository/ExtensionEntry.ts";
  * Simple implementation of an {@link ExtensionRegistry} using an in-memory map.
  */
 export default class InMemoryExtensionRegistry implements ExtensionRegistry {
-  private readonly extensionEntriesByHandle: Map<string, ExtensionEntry> =
-    new Map();
+  private readonly extensionEntriesByHandle: Map<string, ExtensionEntry> = new Map();
 
-  private readonly extensionEntriesByExtensionPoint: Map<
-    string,
-    Map<string, ExtensionEntry>
-  > = new Map();
+  private readonly extensionEntriesByExtensionPoint: Map<string, Map<string, ExtensionEntry>> =
+    new Map();
 
   /**
    * @inheritDoc
    *
    * @throws *Error* if the specified Extension handle has already been registered
    */
-  public register(
-    extensionHandle: string,
-    extensionEntry: ExtensionEntry,
-  ): Promise<void> {
+  public register(extensionHandle: string, extensionEntry: ExtensionEntry): Promise<void> {
     if (this.extensionEntriesByHandle.has(extensionHandle)) {
-      return Promise.reject(
-        `Extension handle ${extensionHandle} has already been registered`,
-      );
+      return Promise.reject(`Extension handle ${extensionHandle} has already been registered`);
     }
     this.extensionEntriesByHandle.set(extensionHandle, extensionEntry);
 
-    let extensionEntries = this.extensionEntriesByExtensionPoint.get(
-      extensionEntry.extensionPoint,
-    );
+    let extensionEntries = this.extensionEntriesByExtensionPoint.get(extensionEntry.extensionPoint);
 
     if (extensionEntries === undefined) {
       extensionEntries = new Map();
-      this.extensionEntriesByExtensionPoint.set(
-        extensionEntry.extensionPoint,
-        extensionEntries,
-      );
+      this.extensionEntriesByExtensionPoint.set(extensionEntry.extensionPoint, extensionEntries);
     }
     extensionEntries.set(extensionHandle, extensionEntry);
 
@@ -59,11 +46,7 @@ export default class InMemoryExtensionRegistry implements ExtensionRegistry {
     return Promise.resolve(Object.freeze(extensionEntry));
   }
 
-  public getExtensions(
-    extensionPoint: string,
-  ): Promise<ReadonlyMap<string, ExtensionEntry>> {
-    return Promise.resolve(
-      this.extensionEntriesByExtensionPoint.get(extensionPoint) || new Map(),
-    );
+  public getExtensions(extensionPoint: string): Promise<ReadonlyMap<string, ExtensionEntry>> {
+    return Promise.resolve(this.extensionEntriesByExtensionPoint.get(extensionPoint) || new Map());
   }
 }

package/src/plugin_manager/util/PluginLoader.ts

@@ -56,9 +56,7 @@ async function getLocalUrl(remoteUrl: string) {
  *
  * @param url the URL of the module to import.
  */
-export default async function loadPlugin(
-  url: string,
-): Promise<Readonly<PluginLoadResult>> {
+export default async function loadPlugin(url: string): Promise<Readonly<PluginLoadResult>> {
   const result: PluginLoadResult = {
     isValidPlugin: false,
     plugin: undefined,
@@ -71,10 +69,9 @@ export default async function loadPlugin(
     module = await import(url);
   } catch (err) {
     if (
-      ((err as { message: string }).message === undefined) ||
-      (!(err as { message: string }).message.startsWith("ENOENT")) ||
-      (!url.toLowerCase().startsWith("http://") &&
-        !url.toLowerCase().startsWith("https://"))
+      (err as { message: string }).message === undefined ||
+      !(err as { message: string }).message.startsWith("ENOENT") ||
+      (!url.toLowerCase().startsWith("http://") && !url.toLowerCase().startsWith("https://"))
     ) {
       result.error = err as Error;
       return result;
@@ -93,25 +90,19 @@ export default async function loadPlugin(
 
   // check the assumed Plugin has an array of extension descriptors
   if (!Array.isArray(potentialPlugin.extensionDescriptors)) {
-    result.error = new Error(
-      `Plugin from ${url} does not provide an extensionDescriptors array`,
-    );
+    result.error = new Error(`Plugin from ${url} does not provide an extensionDescriptors array`);
     return result;
   }
 
   // At this point assume it is a valid plugin and then disprove this
   result.isValidPlugin = true;
 
-  for (
-    const potentialExtensionDescriptor of potentialPlugin
-      .extensionDescriptors
-  ) {
+  for (const potentialExtensionDescriptor of potentialPlugin.extensionDescriptors) {
     // check for valid {@link ExtensionDescriptor.extensionPoint}
     if (
-      (potentialExtensionDescriptor.extensionPoint === undefined) ||
-      (!(potentialExtensionDescriptor.extensionPoint as unknown instanceof
-        String) &&
-        (typeof potentialExtensionDescriptor.extensionPoint !== "string"))
+      potentialExtensionDescriptor.extensionPoint === undefined ||
+      (!((potentialExtensionDescriptor.extensionPoint as unknown) instanceof String) &&
+        typeof potentialExtensionDescriptor.extensionPoint !== "string")
     ) {
       result.isValidPlugin = false;
       result.error = new Error(
@@ -121,10 +112,9 @@ export default async function loadPlugin(
     }
     // check for valid {@link ExtensionDescriptor.factory.create function}
     if (
-      (potentialExtensionDescriptor.factory === undefined) ||
-      (potentialExtensionDescriptor.factory.create === undefined) ||
-      !(potentialExtensionDescriptor.factory.create as unknown instanceof
-        Function)
+      potentialExtensionDescriptor.factory === undefined ||
+      potentialExtensionDescriptor.factory.create === undefined ||
+      !((potentialExtensionDescriptor.factory.create as unknown) instanceof Function)
     ) {
       result.isValidPlugin = false;
       result.error = new Error(

package/tests/fixtures/InvalidPlugin2.ts

@@ -1,5 +1,7 @@
 export default {
-  extensionDescriptors: [{
-    extensionData: "foo",
-  }],
+  extensionDescriptors: [
+    {
+      extensionData: "foo",
+    },
+  ],
 };

package/tests/fixtures/InvalidPlugin3.ts

@@ -1,5 +1,7 @@
 export default {
-  extensionDescriptors: [{
-    extensionPoint: "foo",
-  }],
+  extensionDescriptors: [
+    {
+      extensionPoint: "foo",
+    },
+  ],
 };

package/tests/fixtures/InvalidPlugin4.ts

@@ -1,6 +1,8 @@
 export default {
-  extensionDescriptors: [{
-    extensionPoint: "foo",
-    factory: "bar",
-  }],
+  extensionDescriptors: [
+    {
+      extensionPoint: "foo",
+      factory: "bar",
+    },
+  ],
 };

package/tests/fixtures/InvalidPlugin5.ts

@@ -1,8 +1,10 @@
 export default {
-  extensionDescriptors: [{
-    extensionPoint: "foo",
-    factory: {
-      bar: () => {},
+  extensionDescriptors: [
+    {
+      extensionPoint: "foo",
+      factory: {
+        bar: () => {},
+      },
     },
-  }],
+  ],
 };

package/tests/fixtures/ValidPlugin1.ts

@@ -26,9 +26,7 @@ export const extensionDescriptor1: ExtensionDescriptor = {
 const plugin1: Plugin = {
   pluginData: new Map([["foo", "bar"]]),
 
-  extensionDescriptors: [
-    extensionDescriptor1,
-  ],
+  extensionDescriptors: [extensionDescriptor1],
 };
 
 export default plugin1;

package/tests/plugin_manager/DefaultPluginManager_test.ts

@@ -2,16 +2,11 @@ import { describe, expect, test } from "bun:test";
 import path from "node:path";
 import DefaultPluginManager from "../../src/plugin_manager/DefaultPluginManager.ts";
 import UrlListPluginRepository from "../../src/plugin_manager/plugin_repository/UrlListPluginRepository.ts";
-import {
-  EXTENSION_POINT_1,
-  type ExtensionPoint1,
-} from "../fixtures/Constants.ts";
+import { EXTENSION_POINT_1, type ExtensionPoint1 } from "../fixtures/Constants.ts";
 
-const PLUGIN_1_URL = "file://" +
-  path.join(
-    path.dirname(Bun.fileURLToPath(import.meta.url)),
-    "../fixtures/ValidPlugin1.ts",
-  );
+const PLUGIN_1_URL =
+  "file://" +
+  path.join(path.dirname(Bun.fileURLToPath(import.meta.url)), "../fixtures/ValidPlugin1.ts");
 
 describe("DefaultPluginManager Tests", () => {
   test("Register without a plugin repository does not fail", async () => {
@@ -24,21 +19,15 @@ describe("DefaultPluginManager Tests", () => {
     const urlListPluginRepository = new UrlListPluginRepository(
       new Set([{ url: PLUGIN_1_URL, extensionPoints: [EXTENSION_POINT_1] }]),
     );
-    const defaultPluginManager = new DefaultPluginManager([
-      urlListPluginRepository,
-    ]);
+    const defaultPluginManager = new DefaultPluginManager([urlListPluginRepository]);
 
-    let extensions = await defaultPluginManager.getRegisteredExtensions(
-      EXTENSION_POINT_1,
-    );
+    let extensions = await defaultPluginManager.getRegisteredExtensions(EXTENSION_POINT_1);
 
     expect(extensions.length).toEqual(0);
 
     await defaultPluginManager.registerExtensions(EXTENSION_POINT_1);
 
-    extensions = await defaultPluginManager.getRegisteredExtensions(
-      EXTENSION_POINT_1,
-    );
+    extensions = await defaultPluginManager.getRegisteredExtensions(EXTENSION_POINT_1);
 
     expect(extensions.length).toEqual(1);
   });
@@ -47,23 +36,17 @@ describe("DefaultPluginManager Tests", () => {
     const urlListPluginRepository = new UrlListPluginRepository(
       new Set([{ url: PLUGIN_1_URL, extensionPoints: [EXTENSION_POINT_1] }]),
     );
-    const defaultPluginManager = new DefaultPluginManager([
-      urlListPluginRepository,
-    ]);
+    const defaultPluginManager = new DefaultPluginManager([urlListPluginRepository]);
 
     await defaultPluginManager.registerExtensions(EXTENSION_POINT_1);
 
-    let extensions = await defaultPluginManager.getRegisteredExtensions(
-      EXTENSION_POINT_1,
-    );
+    let extensions = await defaultPluginManager.getRegisteredExtensions(EXTENSION_POINT_1);
 
     expect(extensions.length).toEqual(1);
 
     await defaultPluginManager.registerExtensions(EXTENSION_POINT_1);
 
-    extensions = await defaultPluginManager.getRegisteredExtensions(
-      EXTENSION_POINT_1,
-    );
+    extensions = await defaultPluginManager.getRegisteredExtensions(EXTENSION_POINT_1);
 
     expect(extensions.length).toEqual(1);
   });
@@ -72,24 +55,20 @@ describe("DefaultPluginManager Tests", () => {
     const urlListPluginRepository = new UrlListPluginRepository(
       new Set([{ url: PLUGIN_1_URL, extensionPoints: [EXTENSION_POINT_1] }]),
     );
-    const defaultPluginManager = new DefaultPluginManager([
-      urlListPluginRepository,
-    ]);
+    const defaultPluginManager = new DefaultPluginManager([urlListPluginRepository]);
 
     await defaultPluginManager.registerExtensions(EXTENSION_POINT_1);
 
-    const extensionInfos = await defaultPluginManager.getRegisteredExtensions(
-      EXTENSION_POINT_1,
-    );
+    const extensionInfos = await defaultPluginManager.getRegisteredExtensions(EXTENSION_POINT_1);
 
     const extensionInfo = extensionInfos[0];
 
     expect(extensionInfo.pluginData?.get("foo"), "bar");
     expect(extensionInfo.extensionData?.get("foo"), "bar");
 
-    const instance = await defaultPluginManager.instantiate(
+    const instance = (await defaultPluginManager.instantiate(
       extensionInfo.extensionHandle,
-    ) as ExtensionPoint1;
+    )) as ExtensionPoint1;
 
     expect(instance.sayHello()).toEqual("hello");
   });

package/tests/plugin_manager/plugin_repository/UrlListPluginRepository_test.ts

@@ -1,16 +1,11 @@
 import { describe, expect, test } from "bun:test";
 import path from "node:path";
 import UrlListPluginRepository from "../../../src/plugin_manager/plugin_repository/UrlListPluginRepository.ts";
-import {
-  EXTENSION_POINT_1,
-  EXTENSION_POINT_2,
-} from "../../fixtures/Constants.ts";
+import { EXTENSION_POINT_1, EXTENSION_POINT_2 } from "../../fixtures/Constants.ts";
 
-const PLUGIN_1_URL = "file://" +
-  path.join(
-    path.dirname(Bun.fileURLToPath(import.meta.url)),
-    "../../fixtures/ValidPlugin1.ts",
-  );
+const PLUGIN_1_URL =
+  "file://" +
+  path.join(path.dirname(Bun.fileURLToPath(import.meta.url)), "../../fixtures/ValidPlugin1.ts");
 
 describe("UrlPluginSource Tests", () => {
   test("Throws on empty set of URLs", () => {
@@ -18,10 +13,8 @@ describe("UrlPluginSource Tests", () => {
   });
 
   test("Throws on invalid URL", () => {
-    expect(() =>
-      new UrlListPluginRepository(
-        new Set([{ url: "foo", extensionPoints: ["bar"] }]),
-      )
+    expect(
+      () => new UrlListPluginRepository(new Set([{ url: "foo", extensionPoints: ["bar"] }])),
     ).toThrow();
   });
 
@@ -32,11 +25,7 @@ describe("UrlPluginSource Tests", () => {
     const pluginRepository = new UrlListPluginRepository(urlSet);
 
     let count = 0;
-    for await (
-      const extensionEntry of pluginRepository.scanForExtensions(
-        EXTENSION_POINT_1,
-      )
-    ) {
+    for await (const extensionEntry of pluginRepository.scanForExtensions(EXTENSION_POINT_1)) {
       expect(extensionEntry.pluginId).toEqual(PLUGIN_1_URL);
       expect(extensionEntry.extensionPoint).toEqual(EXTENSION_POINT_1);
       count += 1;
@@ -51,11 +40,7 @@ describe("UrlPluginSource Tests", () => {
     const pluginRepository = new UrlListPluginRepository(urlSet);
 
     let count = 0;
-    for await (
-      const extensionEntry of pluginRepository.scanForExtensions(
-        EXTENSION_POINT_2,
-      )
-    ) {
+    for await (const extensionEntry of pluginRepository.scanForExtensions(EXTENSION_POINT_2)) {
       // this should not be called
       expect(extensionEntry.pluginId, "not good");
       count += 1;

package/tests/plugin_manager/plugin_repository/UrlPluginSource_test.ts

@@ -2,27 +2,19 @@ import { describe, expect, test } from "bun:test";
 import path from "node:path";
 import UrlPluginSource from "../../../src/plugin_manager/plugin_repository/UrlPluginSource.ts";
 
-const PLUGIN_1_URL = "file://" +
-  path.join(
-    path.dirname(Bun.fileURLToPath(import.meta.url)),
-    "../../fixtures/ValidPlugin1.ts",
-  );
-
-const INVALID_PLUGIN_URL = "file://" +
-  path.join(
-    path.dirname(Bun.fileURLToPath(import.meta.url)),
-    "../../fixtures/InvalidPlugin1.ts",
-  );
+const PLUGIN_1_URL =
+  "file://" +
+  path.join(path.dirname(Bun.fileURLToPath(import.meta.url)), "../../fixtures/ValidPlugin1.ts");
+
+const INVALID_PLUGIN_URL =
+  "file://" +
+  path.join(path.dirname(Bun.fileURLToPath(import.meta.url)), "../../fixtures/InvalidPlugin1.ts");
 
 describe("UrlPluginSource Tests", () => {
   test("Throws on invalid plugin", () => {
     const urlPluginSource = new UrlPluginSource();
 
-    expect(
-      urlPluginSource.loadPlugin(
-        new URL(INVALID_PLUGIN_URL),
-      ),
-    ).rejects.toThrow();
+    expect(urlPluginSource.loadPlugin(new URL(INVALID_PLUGIN_URL))).rejects.toThrow();
   });
 
   test("Loads a plugin", async () => {

package/tests/plugin_manager/registry/InMemoryExtensionPointRegistry_test.ts

@@ -1,21 +1,16 @@
 import { describe, expect, test } from "bun:test";
 import InMemoryExtensionPointRegistry from "../../../src/plugin_manager/registry/InMemoryExtensionPointRegistry.ts";
-import {
-  EXTENSION_POINT_1,
-  EXTENSION_POINT_2,
-} from "../../fixtures/Constants.ts";
+import { EXTENSION_POINT_1, EXTENSION_POINT_2 } from "../../fixtures/Constants.ts";
 
 describe("InMemoryExtensionPointRegistry Tests", () => {
   test("Register extension point", async () => {
     const extensionPointRegistry = new InMemoryExtensionPointRegistry();
 
-    expect(await extensionPointRegistry.isRegistered(EXTENSION_POINT_1))
-      .toBeFalse();
+    expect(await extensionPointRegistry.isRegistered(EXTENSION_POINT_1)).toBeFalse();
 
     await extensionPointRegistry.register(EXTENSION_POINT_1);
 
-    expect(await extensionPointRegistry.isRegistered(EXTENSION_POINT_1))
-      .toBeTrue();
+    expect(await extensionPointRegistry.isRegistered(EXTENSION_POINT_1)).toBeTrue();
   });
 
   test("Cannot register extension point twice", async () => {
@@ -23,8 +18,7 @@ describe("InMemoryExtensionPointRegistry Tests", () => {
 
     await extensionPointRegistry.register(EXTENSION_POINT_1);
 
-    expect(extensionPointRegistry.register(EXTENSION_POINT_1))
-      .rejects.toThrow();
+    expect(extensionPointRegistry.register(EXTENSION_POINT_1)).rejects.toThrow();
   });
 
   test("Get registered extension points", async () => {

package/tests/plugin_manager/registry/InMemoryExtensionRegistry_test.ts

@@ -28,8 +28,7 @@ describe("InMemoryExtensionRegistry Tests", () => {
   test("Register extension", async () => {
     const extensionRegistry = new InMemoryExtensionRegistry();
 
-    expect(extensionRegistry.get(EXTENSION_1_HANDLE)).rejects
-      .toThrow();
+    expect(extensionRegistry.get(EXTENSION_1_HANDLE)).rejects.toThrow();
 
     await extensionRegistry.register(EXTENSION_1_HANDLE, extensionEntry1);
 
@@ -41,8 +40,7 @@ describe("InMemoryExtensionRegistry Tests", () => {
 
     await extensionRegistry.register(EXTENSION_1_HANDLE, extensionEntry1);
 
-    expect(extensionRegistry.register(EXTENSION_1_HANDLE, extensionEntry1))
-      .rejects.toThrow();
+    expect(extensionRegistry.register(EXTENSION_1_HANDLE, extensionEntry1)).rejects.toThrow();
   });
 
   test("Get registered extensions", async () => {
@@ -51,22 +49,14 @@ describe("InMemoryExtensionRegistry Tests", () => {
     await extensionRegistry.register(EXTENSION_1_HANDLE, extensionEntry1);
     await extensionRegistry.register(EXTENSION_2_HANDLE, extensionEntry2);
 
-    const extensionEntries1 = await extensionRegistry.getExtensions(
-      EXTENSION_POINT_1,
-    );
+    const extensionEntries1 = await extensionRegistry.getExtensions(EXTENSION_POINT_1);
 
     expect(extensionEntries1.size).toEqual(1);
-    expect(
-      extensionEntries1.get(EXTENSION_1_HANDLE)?.extensionId,
-    ).toEqual(EXTENSION_1_ID);
+    expect(extensionEntries1.get(EXTENSION_1_HANDLE)?.extensionId).toEqual(EXTENSION_1_ID);
 
-    const extensionEntries2 = await extensionRegistry.getExtensions(
-      EXTENSION_POINT_2,
-    );
+    const extensionEntries2 = await extensionRegistry.getExtensions(EXTENSION_POINT_2);
 
     expect(extensionEntries2.size).toEqual(1);
-    expect(
-      extensionEntries2.get(EXTENSION_2_HANDLE)?.extensionId,
-    ).toEqual(EXTENSION_2_ID);
+    expect(extensionEntries2.get(EXTENSION_2_HANDLE)?.extensionId).toEqual(EXTENSION_2_ID);
   });
 });

package/tests/plugin_manager/util/PluginLoader_test.ts

@@ -10,84 +10,58 @@ describe("PluginLoader Tests", () => {
   });
 
   test("Rejects invalid modules", async () => {
-    const pluginLoadResult = await loadPlugin(
-      "../plugin_repository/UrlListPluginRepository.ts",
-    );
+    const pluginLoadResult = await loadPlugin("../plugin_repository/UrlListPluginRepository.ts");
 
     expect(pluginLoadResult.isValidPlugin).toBeFalse();
-    expect(
-      pluginLoadResult.error?.message,
-    ).toEqual(
+    expect(pluginLoadResult.error?.message).toEqual(
       "Plugin from ../plugin_repository/UrlListPluginRepository.ts does not provide an extensionDescriptors array",
     );
   });
 
   test("Rejects invalid plugins", async () => {
-    let pluginLoadResult = await loadPlugin(
-      "../../../tests/fixtures/InvalidPlugin1.ts",
-    );
+    let pluginLoadResult = await loadPlugin("../../../tests/fixtures/InvalidPlugin1.ts");
 
     expect(pluginLoadResult.isValidPlugin).toBeFalse();
     expect(pluginLoadResult.error?.name).toEqual("Error");
-    expect(
-      pluginLoadResult.error?.message,
-    ).toEqual(
+    expect(pluginLoadResult.error?.message).toEqual(
       "Plugin from ../../../tests/fixtures/InvalidPlugin1.ts does not provide an extensionDescriptors array",
     );
 
-    pluginLoadResult = await loadPlugin(
-      "../../../tests/fixtures/InvalidPlugin2.ts",
-    );
+    pluginLoadResult = await loadPlugin("../../../tests/fixtures/InvalidPlugin2.ts");
 
     expect(pluginLoadResult.isValidPlugin).toBeFalse();
     expect(pluginLoadResult.error?.name).toEqual("Error");
-    expect(
-      pluginLoadResult.error?.message,
-    ).toEqual(
+    expect(pluginLoadResult.error?.message).toEqual(
       "Plugin from ../../../tests/fixtures/InvalidPlugin2.ts does not provide an extensionPoint string in one of the extensionDescriptors",
     );
 
-    pluginLoadResult = await loadPlugin(
-      "../../../tests/fixtures/InvalidPlugin3.ts",
-    );
+    pluginLoadResult = await loadPlugin("../../../tests/fixtures/InvalidPlugin3.ts");
 
     expect(pluginLoadResult.isValidPlugin).toBeFalse();
     expect(pluginLoadResult.error?.name).toEqual("Error");
-    expect(
-      pluginLoadResult.error?.message,
-    ).toEqual(
+    expect(pluginLoadResult.error?.message).toEqual(
       "Plugin from ../../../tests/fixtures/InvalidPlugin3.ts does not provide a factory with a create function in one of the extensionDescriptors",
     );
 
-    pluginLoadResult = await loadPlugin(
-      "../../../tests/fixtures/InvalidPlugin4.ts",
-    );
+    pluginLoadResult = await loadPlugin("../../../tests/fixtures/InvalidPlugin4.ts");
 
     expect(pluginLoadResult.isValidPlugin).toBeFalse();
     expect(pluginLoadResult.error?.name).toEqual("Error");
-    expect(
-      pluginLoadResult.error?.message,
-    ).toEqual(
+    expect(pluginLoadResult.error?.message).toEqual(
       "Plugin from ../../../tests/fixtures/InvalidPlugin4.ts does not provide a factory with a create function in one of the extensionDescriptors",
     );
 
-    pluginLoadResult = await loadPlugin(
-      "../../../tests/fixtures/InvalidPlugin5.ts",
-    );
+    pluginLoadResult = await loadPlugin("../../../tests/fixtures/InvalidPlugin5.ts");
 
     expect(pluginLoadResult.isValidPlugin).toBeFalse();
     expect(pluginLoadResult.error?.name).toEqual("Error");
-    expect(
-      pluginLoadResult.error?.message,
-    ).toEqual(
+    expect(pluginLoadResult.error?.message).toEqual(
       "Plugin from ../../../tests/fixtures/InvalidPlugin5.ts does not provide a factory with a create function in one of the extensionDescriptors",
     );
   });
 
   test("Returns valid plugin", async () => {
-    const pluginLoadResult = await loadPlugin(
-      "../../../tests/fixtures/ValidPlugin1.ts",
-    );
+    const pluginLoadResult = await loadPlugin("../../../tests/fixtures/ValidPlugin1.ts");
 
     expect(pluginLoadResult.isValidPlugin).toBeTrue();
     expect(pluginLoadResult.error).toBeUndefined();

package/tsconfig.json

@@ -8,6 +8,8 @@
     "jsx": "react-jsx",
     "allowJs": true,
 
+    "types": ["bun", "node"],
+
     // Bundler mode
     "moduleResolution": "bundler",
     "allowImportingTsExtensions": true,