refactor(plugin): restructure plugin creation and route handling

This commit introduces significant refactoring to the plugin creation process and route handling. The `buildPlugin.ts` file has been removed, and its functionality has been integrated into `Plugin.ts`. The `createPlugin` function now supports additional options like `handleSetup` and `routeOptions`, allowing for more flexible configuration. The `setupRoute.ts` has been updated to handle different types of configuration (`query` or `params`), improving the plugin's adaptability. These changes aim to enhance maintainability and provide a more robust plugin architecture.

Author: prostarz

src/plugin/Plugin.ts

@@ -2,9 +2,11 @@ import cors from "@elysiajs/cors";
 import Elysia from "elysia";
 import type {
   CreatePluginExtraOptions,
+  CustomHandleSetupFunction,
   HandleReturnFunction,
   HandleSearchFunction,
   PluginSetupWithoutConfig,
+  SetupJsonOptions,
 } from "../types";
 import {
   registerReturnRoute,
@@ -16,8 +18,12 @@ import { Colors } from "./utils/colors";
 export class Plugin {
   private app = new Elysia().use(cors());
   private debug = false;
+  private routeOptions: SetupJsonOptions = {
+    typeOfConfig: "query",
+  };
   private searchHandler: HandleSearchFunction | null = null;
   private returnHandler: HandleReturnFunction | null = null;
+  private customSetupHandler: CustomHandleSetupFunction | null = null;
   private setupData: PluginSetupWithoutConfig | null = null;
   private started = false;
 
@@ -37,19 +43,27 @@ export class Plugin {
   public set handlers({
     search,
     return: ret,
+    setup,
   }: {
     search: HandleSearchFunction;
     return?: HandleReturnFunction;
+    setup?: CustomHandleSetupFunction;
   }) {
     this.searchHandler = search;
     this.returnHandler = ret ?? null;
+    this.customSetupHandler = setup ?? null;
   }
 
   /** Extra options (e.g. debug) */
   public set extraOptions(opts: CreatePluginExtraOptions) {
     this.debug = opts.debug ?? false;
   }
 
+  /** Route options  */
+  public set routeConfig(opts: SetupJsonOptions) {
+    this.routeOptions = opts;
+  }
+
   /** Kick off the HTTP server */
   public listen(port: number): void {
     if (this.started) {
@@ -62,7 +76,9 @@ export class Plugin {
     this.started = true;
     this.registerRoutes();
     this.app.listen(port, (ctx) => {
-      const url = this.setupData!.api_url ?? ctx.url.href;
+      const url = this.setupData?.api_url?.length
+        ? this.setupData?.api_url
+        : ctx.url.href;
       if (this.debug) {
         console.info(
           Colors.create("[plugin] Listening on ")
@@ -92,7 +108,13 @@ export class Plugin {
       throw new Error("Missing setupData; call setupApp first");
     }
 
-    registerSetupRoute(this.app, this.setupData, this.debug);
+    registerSetupRoute(
+      this.app,
+      this.setupData,
+      this.debug,
+      this.customSetupHandler,
+      this.routeOptions
+    );
     registerSearchRoute(this.app, () => this.searchHandler, this.debug);
     registerReturnRoute(this.app, () => this.returnHandler, this.debug);
   }

src/plugin/routes/setupRoute.ts

@@ -1,39 +1,84 @@
 import { PluginSetupJSON } from "@team-falkor/shared-types";
 import Elysia, { t } from "elysia";
-import { PluginSetupWithoutConfig } from "../../types";
+import {
+  CustomHandleSetupFunction,
+  PluginSetupWithoutConfig,
+  SetupJsonOptions,
+} from "../../types";
 import { Colors } from "../utils/colors";
 
 export function registerSetupRoute(
   app: Elysia,
   setupData: PluginSetupWithoutConfig,
-  debug: boolean
+  debug: boolean,
+  getHandler: CustomHandleSetupFunction | null,
+  options: SetupJsonOptions = {
+    typeOfConfig: "query",
+  }
 ) {
-  app.get(
-    "/setup.json",
-    ({ query }) => {
-      if (debug) {
-        console.log(
-          Colors.create("[plugin] GET /setup.json").blue.toString(),
-          query?.search
-            ? Colors.create(
-                `filters: ${query.search.join(", ")}`
-              ).magenta.toString()
-            : ""
-        );
+  if (options.typeOfConfig === "query")
+    app.get(
+      "/setup.json",
+      ({ query }) => {
+        if (debug) {
+          console.log(
+            Colors.create("[plugin] GET /setup.json").blue.toString(),
+            query?.search
+              ? Colors.create(
+                  `filters: ${query.search.join(", ")}`
+                ).magenta.toString()
+              : ""
+          );
+        }
+
+        if (getHandler) {
+          const response = getHandler(query?.search);
+          return response;
+        }
+
+        const response: PluginSetupJSON = {
+          ...setupData,
+          config: query?.search ? { search: query.search } : false,
+        };
+        return response;
+      },
+      {
+        query: t.Optional(
+          t.Object({
+            search: t.Array(t.String()),
+          })
+        ),
       }
+    );
+
+  if (options.typeOfConfig === "params")
+    app.get(
+      ":search/setup.json",
+      ({ params }) => {
+        const search = params.search?.split("%20");
 
-      const response: PluginSetupJSON = {
-        ...setupData,
-        config: query?.search ? { search: query.search } : false,
-      };
-      return response;
-    },
-    {
-      query: t.Optional(
-        t.Object({
-          search: t.Array(t.String()),
-        })
-      ),
-    }
-  );
+        if (debug) {
+          console.log(
+            Colors.create("[plugin] GET /setup.json").blue.toString(),
+            search ? Colors.create(`filters: ${search}`).magenta.toString() : ""
+          );
+        }
+
+        if (getHandler) {
+          const response = getHandler(search);
+          return response;
+        }
+
+        const response: PluginSetupJSON = {
+          ...setupData,
+          config: search ? { search: search } : false,
+        };
+        return response;
+      },
+      {
+        params: t.Object({
+          search: t.String(),
+        }),
+      }
+    );
 }