@stacksjs/router 0.75.94 → 0.75.96

package/dist/dashboard-access.d.ts

@@ -0,0 +1,48 @@
+import type { MiddlewareReference } from '@stacksjs/bun-router/runtime';
+/**
+ * Read `dashboard.access` into a prefix-to-roles map.
+ *
+ * Tolerant by design: this runs at route-registration time, on a value an app
+ * wrote, and a malformed entry must not take the dashboard down. Anything that
+ * is not a prefix with at least one non-empty role name is dropped, and a key
+ * naming no known group is collected for the caller to report rather than
+ * silently ignored - a typo'd prefix would otherwise read as a gate that is
+ * quietly absent, which is the failure this whole surface exists to stop.
+ *
+ * An entry with an empty role list is treated as unset rather than as "nobody":
+ * the base middleware still applies, and an app cannot lock itself out of its
+ * own dashboard with `[]`.
+ */
+export declare function resolveDashboardAccess(configured: unknown): DashboardAccess;
+/**
+ * The middleware list for one group: its base, plus the role gate if the app
+ * declared one.
+ *
+ * One `role:a,b` entry rather than one per role, because that is Role.ts's
+ * any-of form and matches what a list of roles means everywhere else in the
+ * framework. Appended after the base so `auth` runs first and the role check
+ * never asks the roles of nobody.
+ */
+export declare function dashboardGroupMiddleware(prefix: string, access: DashboardAccess, base?: readonly MiddlewareReference[]): MiddlewareReference[];
+/**
+ * The one-line boot report about `access` keys naming no known group.
+ *
+ * Returns null when there is nothing to report, matching the ORM's sibling
+ * reports.
+ */
+export declare function describeUnknownDashboardGroups(unknown: readonly string[]): string | null;
+/**
+ * Every group an app may gate, and the single source of truth for the
+ * `DashboardRouteGroup` union in `@stacksjs/types`.
+ *
+ * `dashboard-access.test.ts` pins this list, that union and the prefixes
+ * `defaults/routes/dashboard.ts` actually registers against each other. Three
+ * copies of one list is a mirror, and mirrors drift: a group added to the
+ * routes file and not to this one is a group an app silently cannot gate.
+ */
+export declare const DASHBOARD_ROUTE_GROUPS: readonly ['/ai', '/api/analytics', '/api/commerce', '/api/data', '/api/marketing', '/api/monitoring', '/api/notifications', '/api/queries', '/api/settings', '/cms', '/dashboard', '/dashboard/cms', '/dashboard/commerce', '/deployments', '/infrastructure', '/jobs', '/library', '/models', '/payments', '/queue', '/queues', '/realtime', '/releases', '/voide'];
+export declare interface DashboardAccess {
+  roles: Map<string, string[]>
+  unknown: string[]
+}
+export type DashboardRouteGroupPrefix = (typeof DASHBOARD_ROUTE_GROUPS)[number];

package/dist/dashboard-access.js

@@ -0,0 +1 @@
+export const DASHBOARD_ROUTE_GROUPS=["/ai","/api/analytics","/api/commerce","/api/data","/api/marketing","/api/monitoring","/api/notifications","/api/queries","/api/settings","/cms","/dashboard","/dashboard/cms","/dashboard/commerce","/deployments","/infrastructure","/jobs","/library","/models","/payments","/queue","/queues","/realtime","/releases","/voide"];export function resolveDashboardAccess(configured){const roles=new Map,unknown=[];if(!configured||typeof configured!=="object"||Array.isArray(configured))return{roles,unknown};const known=new Set(DASHBOARD_ROUTE_GROUPS);for(const[key,value]of Object.entries(configured)){const prefix=key.trim();if(!prefix)continue;if(!known.has(prefix)){unknown.push(prefix);continue}const names=(Array.isArray(value)?value:[value]).filter((name)=>typeof name==="string").map((name)=>name.trim()).filter((name)=>name.length>0);if(names.length>0)roles.set(prefix,names)}return{roles,unknown}}export function dashboardGroupMiddleware(prefix,access,base=["auth"]){const names=access.roles.get(prefix);return names?[...base,`role:${names.join(",")}`]:[...base]}export function describeUnknownDashboardGroups(unknown){if(unknown.length===0)return null;return`[dashboard] config/dashboard.ts \`access\` names ${unknown.length===1?"a route group":"route groups"} this framework does not register, so ${unknown.length===1?"it gates":"they gate"} nothing: ${[...unknown].sort().join(", ")}. Valid prefixes are ${DASHBOARD_ROUTE_GROUPS.join(", ")}.`}

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export type { DefaultRouteBundleSelection } from './route-loader';
 // so the path doesn't depend on a 5-level relative reach across the
 // framework defaults tree (stacksjs/stacks#1863, T-10).
 export type { RouteDefinition, RouteRegistry } from './route-types';
+export type { DashboardAccess, DashboardRouteGroupPrefix } from './dashboard-access';
 export type { UrlParams } from './stacks-router';
 export type { ChainableRoute, RouterAction, StacksHandler, StacksRouterInstance } from './stacks-router';
 export type { PathParamRejection, SanitizePathParamOptions } from './path-sanitize';
@@ -47,6 +48,7 @@ export {
 } from './error-handler';
 // Export route introspection helpers
 export { listNamedRoutes, listRegisteredRoutes, routeParams } from './stacks-router';
+export { DASHBOARD_ROUTE_GROUPS, dashboardGroupMiddleware, describeUnknownDashboardGroups, resolveDashboardAccess } from './dashboard-access';
 // Registering an action by import rather than by name: the seam that lets a
 // route hand over the action object it already has, instead of a string that
 // only a runtime `import()` can make sense of. `listRegisteredRoutes()` reports

package/dist/index.js

@@ -1 +1 @@
-import"./request-augmentation";export*from"@stacksjs/bun-router";export{assertRouteMiddlewareResolvable,configureViewDirectories,clearCsrfModuleCache,clearMiddlewareCache,createStacksRouter,disableViewRouting,enhanceRequest,findUnresolvableRouteMiddleware,installMiddlewareHotReload,loadMiddlewareHandlers,resetBootHooks,route,runBootHooks,serve,serverResponse,url,warnOnMultipleRouterInstances}from"./stacks-router";export{cacheRequestQuery,clearCurrentRequest,getCurrentRequest,getTraceId,request,runWithRequest,setCurrentRequest,withTraceId}from"./request-context";export{defineMiddleware,Middleware}from"./middleware";export{appRouteRegistry,bundleMounts,DEFAULT_ROUTE_BUNDLE_FEATURES,DEFAULT_ROUTE_REGISTRY,listRootMountedAppRoutes,loadRoutes,mountedDefaultRouteBundles}from"./route-loader";export{clearTrackedQueries,createErrorResponse,createMiddlewareErrorResponse,createNotFoundResponse,createValidationErrorResponse,getQueryShapeCounts,trackQuery}from"./error-handler";export{listNamedRoutes,listRegisteredRoutes,routeParams}from"./stacks-router";export{isRouterAction,wrapAction}from"./stacks-router";export{createTypedRouter}from"./typed-router";export{clearRouteModelBindings,defineRouteModelBinding,resolveRouteModel,routeModelBindings,setRouteModelFallback}from"./route-model-binding";export{isApiRequest,JSON_CONTENT_TYPE}from"./api-shape";export{rateLimit,rateLimitStatus,clearRateLimit}from"./rate-limit";export{PathParamError,safePathParam,sanitizePathParam}from"./path-sanitize";export{checkApplicationHealth,runHealthProbes}from"./health";export{stream}from"./stacks-router";export{signedUrl,signUrl,verifySignedUrl,verifySignedUrlMiddleware}from"./signed-url";export{EncryptedSessionStore}from"./encrypted-session-store";export{createSessionStore,createStacksSessionStore,DatabaseSessionStore,FileSessionStore,MemorySessionStore,RedisSessionStore}from"./session-factory";
+import"./request-augmentation";export*from"@stacksjs/bun-router";export{assertRouteMiddlewareResolvable,configureViewDirectories,clearCsrfModuleCache,clearMiddlewareCache,createStacksRouter,disableViewRouting,enhanceRequest,findUnresolvableRouteMiddleware,installMiddlewareHotReload,loadMiddlewareHandlers,resetBootHooks,route,runBootHooks,serve,serverResponse,url,warnOnMultipleRouterInstances}from"./stacks-router";export{cacheRequestQuery,clearCurrentRequest,getCurrentRequest,getTraceId,request,runWithRequest,setCurrentRequest,withTraceId}from"./request-context";export{defineMiddleware,Middleware}from"./middleware";export{appRouteRegistry,bundleMounts,DEFAULT_ROUTE_BUNDLE_FEATURES,DEFAULT_ROUTE_REGISTRY,listRootMountedAppRoutes,loadRoutes,mountedDefaultRouteBundles}from"./route-loader";export{clearTrackedQueries,createErrorResponse,createMiddlewareErrorResponse,createNotFoundResponse,createValidationErrorResponse,getQueryShapeCounts,trackQuery}from"./error-handler";export{listNamedRoutes,listRegisteredRoutes,routeParams}from"./stacks-router";export{DASHBOARD_ROUTE_GROUPS,dashboardGroupMiddleware,describeUnknownDashboardGroups,resolveDashboardAccess}from"./dashboard-access";export{isRouterAction,wrapAction}from"./stacks-router";export{createTypedRouter}from"./typed-router";export{clearRouteModelBindings,defineRouteModelBinding,resolveRouteModel,routeModelBindings,setRouteModelFallback}from"./route-model-binding";export{isApiRequest,JSON_CONTENT_TYPE}from"./api-shape";export{rateLimit,rateLimitStatus,clearRateLimit}from"./rate-limit";export{PathParamError,safePathParam,sanitizePathParam}from"./path-sanitize";export{checkApplicationHealth,runHealthProbes}from"./health";export{stream}from"./stacks-router";export{signedUrl,signUrl,verifySignedUrl,verifySignedUrlMiddleware}from"./signed-url";export{EncryptedSessionStore}from"./encrypted-session-store";export{createSessionStore,createStacksSessionStore,DatabaseSessionStore,FileSessionStore,MemorySessionStore,RedisSessionStore}from"./session-factory";

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/router",
   "type": "module",
   "sideEffects": false,
-  "version": "0.75.94",
+  "version": "0.75.96",
   "description": "The Stacks framework router.",
   "author": "Chris Breuer",
   "contributors": [
@@ -67,27 +67,27 @@
   },
   "dependencies": {
     "@stacksjs/bun-router": "^0.1.24",
-    "@stacksjs/cache": "0.75.94",
-    "@stacksjs/collections": "0.75.94",
-    "@stacksjs/config": "0.75.94",
-    "@stacksjs/error-handling": "0.75.94",
-    "@stacksjs/logging": "0.75.94",
-    "@stacksjs/pagination": "0.75.94",
-    "@stacksjs/path": "0.75.94",
-    "@stacksjs/security": "0.75.94",
-    "@stacksjs/storage": "0.75.94",
+    "@stacksjs/cache": "0.75.96",
+    "@stacksjs/collections": "0.75.96",
+    "@stacksjs/config": "0.75.96",
+    "@stacksjs/error-handling": "0.75.96",
+    "@stacksjs/logging": "0.75.96",
+    "@stacksjs/pagination": "0.75.96",
+    "@stacksjs/path": "0.75.96",
+    "@stacksjs/security": "0.75.96",
+    "@stacksjs/storage": "0.75.96",
     "ts-rate-limiter": "^0.4.10"
   },
   "devDependencies": {
-    "@stacksjs/actions": "0.75.94",
-    "@stacksjs/types": "0.75.94",
+    "@stacksjs/actions": "0.75.96",
+    "@stacksjs/types": "0.75.96",
     "better-dx": "^0.2.24"
   },
   "peerDependencies": {
-    "@stacksjs/api": "0.75.94",
-    "@stacksjs/auth": "0.75.94",
-    "@stacksjs/database": "0.75.94",
-    "@stacksjs/validation": "0.75.94"
+    "@stacksjs/api": "0.75.96",
+    "@stacksjs/auth": "0.75.96",
+    "@stacksjs/database": "0.75.96",
+    "@stacksjs/validation": "0.75.96"
   },
   "peerDependenciesMeta": {
     "@stacksjs/api": {