@btst/stack 1.7.0 → 1.9.0

package/dist/shared/{stack.CSce37mX.d.ts → stack.u9iYV6vt.d.ts}

@@ -14,6 +14,16 @@ interface BetterStackContext {
     /** The database adapter */
     adapter: Adapter;
 }
+/**
+ * Context passed to client plugins during route creation
+ * Provides access to all registered plugins for introspection (used by routeDocs plugin)
+ */
+interface ClientStackContext<TPlugins extends Record<string, ClientPlugin<any, any>> = Record<string, ClientPlugin<any, any>>> {
+    /** All registered client plugins */
+    plugins: TPlugins;
+    /** The base path for the client (e.g., "/app") */
+    basePath?: string;
+}
 /**
  * Backend plugin definition
  * Defines API routes and data access for a feature
@@ -50,8 +60,10 @@ interface ClientPlugin<TOverrides = Record<string, never>, TRoutes extends Recor
     /**
      * Define routes (pages) for this plugin
      * Returns yar routes that will be composed into the router
+     *
+     * @param context - Optional context with access to all plugins (for introspection)
      */
-    routes: () => TRoutes;
+    routes: (context?: ClientStackContext) => TRoutes;
     /**
      * Optional sitemap generator for this plugin. Should return absolute URLs.
      * Implementations can call their own API endpoints to include dynamic routes.
@@ -142,4 +154,4 @@ type SitemapEntry = {
 };
 type Sitemap = Array<SitemapEntry>;
 
-export type { BackendPlugin as B, ClientPlugin as C, PluginOverrides as P, Sitemap as S, BetterStackContext as a, PluginRoutes as b, ClientLibConfig as c, ClientLib as d, PrefixedPluginRoutes as e, BackendLibConfig as f, BackendLib as g };
+export type { BackendPlugin as B, ClientPlugin as C, PluginOverrides as P, SitemapEntry as S, BetterStackContext as a, ClientStackContext as b, Sitemap as c, PluginRoutes as d, ClientLibConfig as e, ClientLib as f, PrefixedPluginRoutes as g, BackendLibConfig as h, BackendLib as i };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@btst/stack",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "description": "A composable, plugin-based library for building full-stack applications.",
   "repository": {
     "type": "git",
@@ -257,6 +257,17 @@
         "default": "./dist/plugins/open-api/api/index.cjs"
       }
     },
+    "./plugins/route-docs/client": {
+      "import": {
+        "types": "./dist/plugins/route-docs/client/index.d.ts",
+        "default": "./dist/plugins/route-docs/client/index.mjs"
+      },
+      "require": {
+        "types": "./dist/plugins/route-docs/client/index.d.cts",
+        "default": "./dist/plugins/route-docs/client/index.cjs"
+      }
+    },
+    "./plugins/route-docs/css": "./dist/plugins/route-docs/style.css",
     "./dist/*": "./dist/*",
     "./ui/css": "./dist/ui/components.css",
     "./package.json": "./package.json"
@@ -325,6 +336,9 @@
       ],
       "plugins/open-api/api": [
         "./dist/plugins/open-api/api/index.d.ts"
+      ],
+      "plugins/route-docs/client": [
+        "./dist/plugins/route-docs/client/index.d.ts"
       ]
     }
   },

package/src/client/index.ts

@@ -4,10 +4,11 @@ import type {
 	ClientLibConfig,
 	ClientLib,
 	ClientPlugin,
+	ClientStackContext,
 	PluginRoutes,
 	Sitemap,
 } from "../types";
-export type { ClientPlugin } from "../types";
+export type { ClientPlugin, ClientStackContext } from "../types";
 
 /**
  * Creates the client library with plugin support
@@ -60,15 +61,21 @@ export function createStackClient<
 	TPlugins extends Record<string, ClientPlugin<any, any>>,
 	TRoutes extends PluginRoutes<TPlugins> = PluginRoutes<TPlugins>,
 >(config: ClientLibConfig<TPlugins>): ClientLib<TRoutes> {
-	const { plugins } = config;
+	const { plugins, basePath } = config;
 
 	// Collect all routes from all plugins
 	// We build this with type assertions to preserve literal keys
 	const allRoutes = {} as TRoutes;
 
+	// Create the context object to pass to plugin routes
+	const clientStackContext: ClientStackContext<TPlugins> = {
+		plugins,
+		basePath,
+	};
+
 	for (const [pluginKey, plugin] of Object.entries(plugins)) {
-		// Add routes
-		const pluginRoutes = plugin.routes();
+		// Add routes - pass the context for plugins that need introspection (e.g., routeDocs)
+		const pluginRoutes = plugin.routes(clientStackContext);
 		Object.assign(allRoutes, pluginRoutes);
 	}