@flowscripter/dynamic-plugin-framework 1.3.16 → 1.3.17

package/bun.lock

@@ -4,23 +4,23 @@
     "": {
       "name": "@flowscripter/dynamic-plugin-framework",
       "devDependencies": {
-        "@types/bun": "^1.2.5",
+        "@types/bun": "^1.2.9",
       },
       "peerDependencies": {
-        "typescript": "^5.8.2",
+        "typescript": "^5.8.3",
       },
     },
   },
   "packages": {
-    "@types/bun": ["@types/bun@1.2.5", "", { "dependencies": { "bun-types": "1.2.5" } }, "sha512-w2OZTzrZTVtbnJew1pdFmgV99H0/L+Pvw+z1P67HaR18MHOzYnTYOi6qzErhK8HyT+DB782ADVPPE92Xu2/Opg=="],
+    "@types/bun": ["@types/bun@1.2.9", "", { "dependencies": { "bun-types": "1.2.9" } }, "sha512-epShhLGQYc4Bv/aceHbmBhOz1XgUnuTZgcxjxk+WXwNyDXavv5QHD1QEFV0FwbTSQtNq6g4ZcV6y0vZakTjswg=="],
 
     "@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.2.5", "", { "dependencies": { "@types/node": "*", "@types/ws": "~8.5.10" } }, "sha512-3oO6LVGGRRKI4kHINx5PIdIgnLRb7l/SprhzqXapmoYkFl5m4j6EvALvbDVuuBFaamB46Ap6HCUxIXNLCGy+tg=="],
+    "bun-types": ["bun-types@1.2.9", "", { "dependencies": { "@types/node": "*", "@types/ws": "*" } }, "sha512-dk/kOEfQbajENN/D6FyiSgOKEuUi9PWfqKQJEgwKrCMWbjS/S6tEXp178mWvWAcUSYm9ArDlWHZKO3T/4cLXiw=="],
 
-    "typescript": ["typescript@5.8.2", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-aJn6wq13/afZp/jT9QZmwEjDqqvSGp1VT5GVg+f/t6/oVyrgXM6BY1h9BRh/O5p3PlUPAe+WuiEZOmb/49RqoQ=="],
+    "typescript": ["typescript@5.8.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ=="],
 
     "undici-types": ["undici-types@6.20.0", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
   }

package/package.json

@@ -16,14 +16,14 @@
   ],
   "module": "index.ts",
   "type": "module",
-  "version": "1.3.16",
+  "version": "1.3.17",
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@types/bun": "^1.2.5"
+    "@types/bun": "^1.2.9"
   },
   "peerDependencies": {
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.3"
   }
 }

package/src/plugin_manager/plugin_repository/UrlListPluginRepository.ts

@@ -5,6 +5,7 @@ import UrlPluginSource from "./UrlPluginSource.ts";
 
 /**
  * Implementation of {@link PluginRepository} using a provided set of URLs to access Plugins.
+ * Each plugin URL is linked to a list of extension points that are available in the Plugin.
  *
  * When scanning for Plugins each provided URL will be used to attempt to load a Plugin and examine it.
  */
@@ -16,29 +17,49 @@ export default class UrlListPluginRepository implements PluginRepository {
    *
    * @throws *Error* if the URL set contains a non-valid URL.
    */
-  public constructor(private readonly urls: Set<string>) {
-    if (!urls || (urls.size === 0)) {
-      throw new Error(`Undefined or empty set of URLs provided`);
+  public constructor(
+    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`,
+      );
     }
-    this.urls.forEach((url) => {
+    this.urlsAndExtensionPoints.forEach((urlAndExtensionPoint) => {
       try {
-        new URL(url);
+        new URL(urlAndExtensionPoint.url);
       } catch (err) {
         throw new Error(
-          `Cannot parse ${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)
+      ) {
+        throw new Error(`Undefined or empty set of extension points provided`);
+      }
     });
   }
 
   private async *getExtensionEntryAsyncIterable(
     extensionPoint: string,
   ): AsyncIterable<ExtensionEntry> {
-    // As this is just a list of URLs we need to load each and then filter for extensionPoint
-    for await (const candidateUrl of this.urls) {
-      const plugin = await this.pluginSource.loadPlugin(new URL(candidateUrl));
+    // We need to iterate each entry and filter for extensionPoint
+    for await (const urlAndExtensionPoints of this.urlsAndExtensionPoints) {
+      if (!urlAndExtensionPoints.extensionPoints.includes(extensionPoint)) {
+        continue;
+      }
+      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
         // filter Extensions in each Plugin by specified Extension Point
         // and map any matches to an Extension Entry
         for (let i = 0; i < plugin.extensionDescriptors.length; i++) {
@@ -47,7 +68,7 @@ export default class UrlListPluginRepository implements PluginRepository {
             continue;
           }
           yield {
-            pluginId: candidateUrl,
+            pluginId: urlAndExtensionPoints.url,
             extensionId: `${i}`,
             extensionPoint,
             pluginData: plugin.pluginData,

package/src/plugin_manager/util/PluginLoader.ts

@@ -1,3 +1,6 @@
+import { mkdir } from "node:fs/promises";
+import os from "node:os";
+import path from "node:path";
 import type Plugin from "../../api/plugin/Plugin.ts";
 
 /**
@@ -20,10 +23,38 @@ export interface PluginLoadResult {
   error?: Error;
 }
 
+async function getLocalUrl(remoteUrl: string) {
+  const url = new URL(remoteUrl);
+  const urlPath = url.pathname;
+
+  // look in local cache location
+  const localPluginFolder = path.join(os.homedir(), ".flowscripter", "plugin");
+  const localPluginPath = path.join(localPluginFolder, urlPath);
+  const installePluginFile = Bun.file(localPluginPath);
+  const exists = await installePluginFile.exists();
+
+  if (exists) {
+    return localPluginPath;
+  }
+
+  await mkdir(path.dirname(localPluginPath), { recursive: true });
+
+  const result = await fetch(remoteUrl);
+
+  await Bun.write(installePluginFile, result);
+
+  return localPluginPath;
+}
+
 /**
  * Utility function to import a specified module and validate it is a {@link Plugin} implementation.
  *
- * @param url the URL of the module to import
+ * If the URL specified is not local filesystem (e.g. http(s)://) and the dynamic import fails with ENOENT
+ * then the remote item will be fetched and the contents of the response will be used as the module source
+ * i.e. a local dynamic import will be attempted.  This is because the Bun runtime does not support importing
+ * remote modules directly as per https://github.com/oven-sh/bun/issues/38
+ *
+ * @param url the URL of the module to import.
  */
 export default async function loadPlugin(
   url: string,
@@ -39,6 +70,19 @@ export default async function loadPlugin(
   try {
     module = await import(url);
   } catch (err) {
+    if ((err instanceof Error) && (err.message === "ENOENT")) {
+      const urlLower = url.toLowerCase();
+      if (urlLower.startsWith("http://") || urlLower.startsWith("https://")) {
+        const localUrl = await getLocalUrl(url);
+
+        try {
+          module = await import(localUrl);
+        } catch (err2) {
+          result.error = err2 as Error;
+          return result;
+        }
+      }
+    }
     result.error = err as Error;
     return result;
   }

package/tests/plugin_manager/DefaultPluginManager_test.ts

@@ -22,7 +22,7 @@ describe("DefaultPluginManager Tests", () => {
 
   test("Successfully register extension point", async () => {
     const urlListPluginRepository = new UrlListPluginRepository(
-      new Set([PLUGIN_1_URL]),
+      new Set([{ url: PLUGIN_1_URL, extensionPoints: [EXTENSION_POINT_1] }]),
     );
     const defaultPluginManager = new DefaultPluginManager([
       urlListPluginRepository,
@@ -45,7 +45,7 @@ describe("DefaultPluginManager Tests", () => {
 
   test("Registering an extension point twice has no effect", async () => {
     const urlListPluginRepository = new UrlListPluginRepository(
-      new Set([PLUGIN_1_URL]),
+      new Set([{ url: PLUGIN_1_URL, extensionPoints: [EXTENSION_POINT_1] }]),
     );
     const defaultPluginManager = new DefaultPluginManager([
       urlListPluginRepository,
@@ -70,7 +70,7 @@ describe("DefaultPluginManager Tests", () => {
 
   test("Instantiating an extension works", async () => {
     const urlListPluginRepository = new UrlListPluginRepository(
-      new Set([PLUGIN_1_URL]),
+      new Set([{ url: PLUGIN_1_URL, extensionPoints: [EXTENSION_POINT_1] }]),
     );
     const defaultPluginManager = new DefaultPluginManager([
       urlListPluginRepository,

package/tests/plugin_manager/plugin_repository/UrlListPluginRepository_test.ts

@@ -18,12 +18,16 @@ describe("UrlPluginSource Tests", () => {
   });
 
   test("Throws on invalid URL", () => {
-    expect(() => new UrlListPluginRepository(new Set("foo"))).toThrow();
+    expect(() =>
+      new UrlListPluginRepository(
+        new Set([{ url: "foo", extensionPoints: ["bar"] }]),
+      )
+    ).toThrow();
   });
 
   test("Successfully scans for matching plugin", async () => {
-    const urlSet = new Set<string>();
-    urlSet.add(PLUGIN_1_URL);
+    const urlSet = new Set<{ url: string; extensionPoints: string[] }>();
+    urlSet.add({ url: PLUGIN_1_URL, extensionPoints: [EXTENSION_POINT_1] });
 
     const pluginRepository = new UrlListPluginRepository(urlSet);
 
@@ -41,8 +45,8 @@ describe("UrlPluginSource Tests", () => {
   });
 
   test("Successfully scans for non-matching plugin", async () => {
-    const urlSet = new Set<string>();
-    urlSet.add(PLUGIN_1_URL);
+    const urlSet = new Set<{ url: string; extensionPoints: string[] }>();
+    urlSet.add({ url: PLUGIN_1_URL, extensionPoints: [EXTENSION_POINT_1] });
 
     const pluginRepository = new UrlListPluginRepository(urlSet);