feat: infer plugin id for modules and routes

Author: aXenDeveloper

apps/docs/content/docs/dev/api/modules.mdx

@@ -10,10 +10,8 @@ Think of modules as containers for related API endpoints. They help organize you
 ```ts title="plugins/blog/src/api/modules/categories/categories.module.ts"
 import { buildModule } from "@vitnode/core/api/lib/module";
 
-import { CONFIG_PLUGIN } from "@/config";
 
 export const categoriesModule = buildModule({
-  pluginId: CONFIG_PLUGIN.id,
   name: "categories",
   routes: [] // We'll populate this soon!
 });
@@ -26,12 +24,10 @@ Want to create a module hierarchy? VitNode's got your back! Nested modules are p
 ```ts title="plugins/blog/src/api/modules/categories/categories.module.ts"
 import { buildModule } from "@vitnode/core/api/lib/module";
 
-import { CONFIG_PLUGIN } from "@/config";
 
 import { postsModule } from "./posts/posts.module"; // [!code ++]
 
 export const categoriesModule = buildModule({
-  pluginId: CONFIG_PLUGIN.id,
   name: "categories",
   routes: [],
   modules: [postsModule] // [!code ++]
@@ -45,14 +41,12 @@ This creates a structure: `/api/{plugin_id}/categories/posts/*`
 ```ts title="plugins/blog/src/config.api.ts"
 import { buildApiPlugin } from "@vitnode/core/api/lib/plugin";
 
-import { CONFIG_PLUGIN } from "@/config";
 
 import { categoriesModule } from "./api/modules/categories/categories.module"; // [!code ++]
 
 export const blogApiPlugin = () => {
   return buildApiPlugin({
-    pluginId: CONFIG_PLUGIN.pluginId,
-    modules: [categoriesModule] // [!code ++]
+      modules: [categoriesModule] // [!code ++]
   });
 };
-```
+```

apps/docs/content/docs/dev/api/routes.mdx

@@ -11,10 +11,8 @@ Now for the fun part - creating actual endpoints! Each route is a small but migh
 import { z } from "@hono/zod-openapi";
 import { buildRoute } from "@vitnode/core/api/lib/route";
 
-import { CONFIG_PLUGIN } from "@/config";
 
 export const getCategoriesRoute = buildRoute({
-  pluginId: CONFIG_PLUGIN.pluginId,
   route: {
     method: "get",
     path: "/",
@@ -54,11 +52,9 @@ export const getCategoriesRoute = buildRoute({
 ```ts title="plugins/blog/src/api/modules/categories/categories.module.ts"
 import { buildModule } from "@vitnode/core/api/lib/module";
 
-import { CONFIG_PLUGIN } from "@/config";
 import { getCategoriesRoute } from "./routes/get.route"; // [!code ++]
 
 export const categoriesModule = buildModule({
-  pluginId: CONFIG_PLUGIN.id,
   name: "categories",
   routes: [getCategoriesRoute] // [!code ++]
 });
@@ -75,10 +71,8 @@ import { z } from "@hono/zod-openapi";
 import { buildRoute } from "@vitnode/core/api/lib/route";
 import { HTTPException } from "hono/http-exception";
 
-import { CONFIG_PLUGIN } from "@/config";
 
 export const getCategoryByIdRoute = buildRoute({
-  pluginId: CONFIG_PLUGIN.pluginId,
   route: {
     method: "get",
     // [!code highlight]
@@ -136,10 +130,8 @@ Query parameters are your best friends for filtering, searching, and pagination.
 import { z } from "@hono/zod-openapi";
 import { buildRoute } from "@vitnode/core/api/lib/route";
 
-import { CONFIG_PLUGIN } from "@/config";
 
 export const searchCategoriesRoute = buildRoute({
-  pluginId: CONFIG_PLUGIN.pluginId,
   route: {
     method: "get",
     path: "/search",
@@ -203,7 +195,6 @@ When you need to send complex data (creating, updating), request bodies are your
 import { z } from "@hono/zod-openapi";
 import { buildRoute } from "@vitnode/core/api/lib/route";
 
-import { CONFIG_PLUGIN } from "@/config";
 
 const createCategorySchema = z.object({
   name: z.string().min(1).max(100).openapi({
@@ -225,7 +216,6 @@ const createCategorySchema = z.object({
 });
 
 export const createCategoryRoute = buildRoute({
-  pluginId: CONFIG_PLUGIN.pluginId,
   route: {
     method: "post",
     path: "/",
@@ -274,4 +264,4 @@ export const createCategoryRoute = buildRoute({
     return c.json(newCategory, 201);
   }
 });
-```
+```

apps/docs/content/docs/dev/captcha/custom-adapter.mdx

@@ -16,7 +16,6 @@ If you want to use captcha in your custom form or somewhere else, follow these s
 import { buildRoute } from "@vitnode/core/api/lib/route";
 
 export const exampleRoute = buildRoute({
-  pluginId: CONFIG_PLUGIN.pluginId,
   route: {
     method: "post",
     description: "Create a new user",

apps/docs/content/docs/dev/captcha/index.mdx

@@ -43,7 +43,6 @@ Add `withCaptcha` to your route config to enable captcha validation for this rou
 import { buildRoute } from "@vitnode/core/api/lib/route";
 
 export const exampleRoute = buildRoute({
-  pluginId: CONFIG_PLUGIN.pluginId,
   route: {
     method: "post",
     description: "Create a new user",

apps/docs/content/docs/dev/cron/index.mdx

@@ -46,13 +46,11 @@ export const cleanCron = buildCron({
 
 ```ts title="modules/clean/clean.module.ts"
 import { buildModule } from "@vitnode/core/api/lib/module";
-import { CONFIG_PLUGIN } from "@/config";
 
 // [!code ++]
 import { cleanCron } from "./cron/clean.cron";
 
 export const cronModule = buildModule({
-  pluginId: CONFIG_PLUGIN.pluginId,
   name: "clean",
   routes: [],
   // [!code ++]
@@ -69,4 +67,4 @@ When your CRON job will run first time, you should see your job in AdminCP under
 
 </Step>
 
-</Steps>
+</Steps>

apps/docs/content/docs/dev/database/index.mdx

@@ -27,7 +27,6 @@ Access the database in your plugin handlers using `c.get('database')` from the H
 
 ```ts title="plugins/{plugin_name}/src/routes/posts.ts"
 export const postsRoute = buildRoute({
-  pluginId: CONFIG_PLUGIN.pluginId,
   route: {},
   handler: async (c) => {
     // [!code ++:7]

apps/docs/content/docs/dev/database/pagination.mdx

@@ -19,11 +19,9 @@ import {
   zodPaginationPageInfo,
   zodPaginationQuery
 } from "@/api/lib/with-pagination";
-import { CONFIG_PLUGIN } from "@/config";
 import { core_cron } from "@/database/cron";
 
 export const getCronsRoute = buildRoute({
-  pluginId: CONFIG_PLUGIN.pluginId,
   route: {
     method: "get",
     description: "Get Admin Cron Logs",
@@ -275,4 +273,4 @@ export default function UsersPage() {
     </React.Suspense>
   );
 }
-```
+```

packages/vitnode/src/api/lib/module.ts

@@ -3,51 +3,45 @@ import { OpenAPIHono } from "@hono/zod-openapi";
 import type { BuildCronReturn } from "./cron";
 import type { Route } from "./route";
 
-export interface BuildModuleType<T extends Route, Plugin extends string> {
-  plugin: Plugin;
-  routes: T;
-}
+import { getCurrentPluginId } from "./plugin-context";
 
 export interface BaseBuildModuleReturn<
-  P extends string = string,
   M extends string = string,
-  Routes extends Route<P>[] = Route<P>[],
+  Routes extends Route[] = Route[],
 > {
   cronJobs: BuildCronReturn[];
   hono: OpenAPIHono;
-  modules?: BaseBuildModuleReturn<P>[];
+  modules?: BaseBuildModuleReturn[];
   name: M;
-  pluginId: P;
+  pluginId: string;
   routes: Routes;
 }
 
 export interface BuildModuleReturn<
-  P extends string,
   M extends string,
-  Routes extends Route<P>[] = Route<P>[],
-  Modules extends BaseBuildModuleReturn<P>[] = BaseBuildModuleReturn<P>[],
-> extends BaseBuildModuleReturn<P, M, Routes> {
+  Routes extends Route[] = Route[],
+  Modules extends BaseBuildModuleReturn[] = BaseBuildModuleReturn[],
+> extends BaseBuildModuleReturn<M, Routes> {
   modules?: Modules;
 }
 
 export function buildModule<
-  const P extends string,
   const M extends string,
-  const Routes extends Route<P>[],
-  Modules extends BaseBuildModuleReturn<P>[],
+  const Routes extends Route[],
+  Modules extends BaseBuildModuleReturn[],
 >({
   routes,
-  pluginId,
   name,
   modules,
   cronJobs = [],
 }: {
   cronJobs?: BuildCronReturn[];
   modules?: Modules;
   name: M;
-  pluginId: P;
   routes: Routes;
-}): BuildModuleReturn<P, M, Routes, Modules> {
+}): BuildModuleReturn<M, Routes, Modules> {
+  const pluginId = getCurrentPluginId();
+
   const hono = new OpenAPIHono();
 
   if (routes) {

packages/vitnode/src/api/lib/plugin-context.ts

@@ -0,0 +1,15 @@
+let currentPluginId: string | undefined;
+
+export const setCurrentPluginId = (pluginId: string) => {
+  currentPluginId = pluginId;
+};
+
+export const getCurrentPluginId = () => {
+  if (!currentPluginId) {
+    throw new Error(
+      "Plugin ID is not defined. Ensure that your plugin config sets it before building modules or routes.",
+    );
+  }
+
+  return currentPluginId;
+};

packages/vitnode/src/api/lib/plugin.ts

@@ -15,7 +15,7 @@ export function buildApiPlugin<P extends string>({
   pluginId,
   modules = [],
 }: {
-  modules?: BuildModuleReturn<P, string>[];
+  modules?: BuildModuleReturn<string>[];
   pluginId: P;
 }): BuildPluginApiReturn {
   // Run for checking if the plugin is valid