adminizer 5.1.0-build.29 → 5.2.0-build.31

package/lib/app-manager/ControllerHandler.d.ts

@@ -6,6 +6,8 @@ interface ControllerRecord {
     method: AppControllerMethod;
     path: string;
     enabled: boolean;
+    /** Removes the route's layout context declaration. */
+    unassign?: () => void;
 }
 export declare class ControllerHandler {
     private adminizer;

package/lib/app-manager/ControllerHandler.js

@@ -19,6 +19,12 @@ export class ControllerHandler {
             path: fullPath,
             enabled: true,
         };
+        if (controller.context) {
+            record.unassign = this.adminizer.contextHandler.assign(controller.route, controller.context, {
+                owner: appName,
+                exact: true,
+            });
+        }
         const middleware = bindWithMiddlewares(this.adminizer, this.adminizer.config.middlewares ?? [], (req, res, next) => {
             if (!record.enabled) {
                 return next();
@@ -69,6 +75,7 @@ export class ControllerHandler {
             return;
         }
         this.removeRoute(record.path, record.method);
+        record.unassign?.();
         this.controllers.delete(id);
         this.adminizer.emitter.emit("app:controller:unregistered", {
             appName: record.appName,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "adminizer",
   "type": "module",
-  "version": "5.1.0-build.29",
+  "version": "5.2.0-build.31",
   "main": "index.js",
   "exports": {
     ".": "./index.js",
@@ -30,7 +30,8 @@
     "build": "npm run copy:backend && npm run compile:backend && npm run compile:ui && npm run build:assets",
     "build:catalog-modules": "cross-env CATALOG_COMPONENT=catalogAction vite build --config fixture/virtual-catalog/vite.config.module.ts && cross-env CATALOG_COMPONENT=Group vite build --config fixture/virtual-catalog/vite.config.module.ts",
     "start:typeorm:seed": "cross-env ORM=typeorm tsx --tsconfig ./fixture/tsconfig.json ./fixture/index.ts",
-    "build:apps": "vite build --config fixture/apps/notification-sender/vite.config.module.ts && vite build --config fixture/apps/module-manager/vite.config.module.ts && vite build --config fixture/apps/navigation/vite.config.module.ts && vite build --config fixture/apps/quill-editor/vite.config.module.ts && vite build --config fixture/apps/widgets/vite.config.module.ts && vite build --config fixture/apps/handsontable-test/vite.config.module.ts && vite build --config fixture/apps/record-scope-test/vite.config.module.ts && npm run build:catalog-modules",
+    "build:context-apps": "cross-env CONTEXT_ENTRY=ContextDemoPage vite build --config fixture/apps/contexts/vite.config.module.ts && cross-env CONTEXT_ENTRY=SupportLayout vite build --config fixture/apps/contexts/vite.config.module.ts && cross-env CONTEXT_ENTRY=StudioLayout vite build --config fixture/apps/contexts/vite.config.module.ts && cross-env CONTEXT_ENTRY=DefaultShellOverrides vite build --config fixture/apps/contexts/vite.config.module.ts && cross-env CONTEXT_ENTRY=SystemShellOverrides vite build --config fixture/apps/contexts/vite.config.module.ts && cross-env CONTEXT_ENTRY=ReportsShellOverrides vite build --config fixture/apps/contexts/vite.config.module.ts",
+    "build:apps": "npm run build:context-apps && vite build --config fixture/apps/notification-sender/vite.config.module.ts && vite build --config fixture/apps/module-manager/vite.config.module.ts && vite build --config fixture/apps/navigation/vite.config.module.ts && vite build --config fixture/apps/quill-editor/vite.config.module.ts && vite build --config fixture/apps/widgets/vite.config.module.ts && vite build --config fixture/apps/handsontable-test/vite.config.module.ts && vite build --config fixture/apps/record-scope-test/vite.config.module.ts && npm run build:catalog-modules",
     "build:ai-assistant": "vite build --config vite.config.ai-assistant.ts",
     "lint": "eslint src",
     "lint:async": "eslint src -c eslint.config.async.mjs"

package/system/bindInertia.js

@@ -4,6 +4,7 @@ import fs from "fs";
 import path from "node:path";
 import { Adminizer } from "../lib/Adminizer.js";
 import { InertiaMenuHelper } from "../helpers/inertiaMenuHelper.js";
+import { toPublicUser } from "../helpers/publicUserHelper.js";
 import { getUiTranslations } from "../lib/ui-i18n/getUiTranslations.js";
 import { getAssetVersion } from "../helpers/assetVersionHelper.js";
 import { COMMON_UI_TRANSLATION_KEYS } from "../lib/ui-i18n/uiTranslationKeys.js";
@@ -132,7 +133,7 @@ export function bindInertia(adminizer) {
             headerName: 'x-xsrf-token'
         }
     }));
-    adminizer.app.use(async (req, _, next) => {
+    adminizer.app.use(async (req, res, next) => {
         checkAuth(req, adminizer);
         const defaultLocale = typeof req.adminizer.config.translation !== "boolean"
             ? req.adminizer.config.translation.defaultLocale
@@ -143,13 +144,30 @@ export function bindInertia(adminizer) {
             lang: locale,
         });
         const menuHelper = new InertiaMenuHelper(adminizer);
-        // Contextual documentation of this page: metadata only, and null when
-        // the subsystem is off or the user may not read documentation.
-        // A broken implementation must never take the panel down with it.
-        const menu = req.user ? await menuHelper.getMenuItems(req) : null;
+        // The layout context of the request decides which menu and which
+        // layout the page gets; the default context reproduces the plain panel.
+        // Context, menu and switcher are computed once, and only when a page
+        // is rendered: API calls and partial reloads that skip them pay nothing.
+        let resolvedContext;
+        const resolveContext = () => resolvedContext ??= (async () => {
+            const context = await adminizer.contextHandler.resolve(req);
+            const contexts = req.user ? await adminizer.contextHandler.listAccessible(req.user) : [];
+            // Only page visits move the user between contexts: a rendered page
+            // asked for by the browser, never an asset or an API call.
+            const isPageVisit = req.headers["x-inertia"] !== undefined || (req.headers.accept ?? "").includes("text/html");
+            if (req.user && contexts.length > 1 && isPageVisit)
+                adminizer.contextHandler.remember(req, res, context);
+            return { context, contexts };
+        })();
+        let resolvedMenu;
+        const resolveMenu = () => resolvedMenu ??= (async () => req.user ? menuHelper.getMenuItems(req, (await resolveContext()).context) : null)();
+        const contextProps = (context) => adminizer.contextHandler.toProps({ ...context, title: req.i18n.__(context.title) });
         const historyAccess = req.user && req.adminizer.config.history.enabled
             ? await req.adminizer.accessRightsHelper.checkPermission(`history-${req.adminizer.config.history?.adapter ?? 'default'}`, req.user)
             : false;
+        // Contextual documentation of this page: metadata only, and null when
+        // the subsystem is off or the user may not read documentation.
+        // A broken implementation must never take the panel down with it.
         let docs = null;
         try {
             docs = req.user ? await adminizer.documentationHandler.forContextMeta(req.user, req.path) : null;
@@ -159,23 +177,28 @@ export function bindInertia(adminizer) {
         }
         req.Inertia.shareProps({
             auth: {
-                user: req.session.userPretended ?? req.user
+                user: toPublicUser(req.session.userPretended ?? req.user)
             },
             routePrefix: req.adminizer.config.routePrefix,
             i18n: {
                 locale,
                 common: commonMessages,
             },
-            menu,
-            menuSections: req.user ? menuHelper.getSections(req) : null,
+            menu: resolveMenu,
+            menuSections: async () => req.user ? menuHelper.getSections(req, (await resolveContext()).context) : null,
+            adminContext: async () => contextProps((await resolveContext()).context),
+            adminContexts: async () => (await resolveContext()).contexts
+                .filter((item) => item.switcher !== false)
+                .map(contextProps),
             // Auto breadcrumbs. A function prop is evaluated by the Inertia
             // adapter only when the key is rendered and only when the page did
             // not send `breadcrumbs` of its own — page props override shared
             // props before evaluation.
-            ...(menu && adminizer.config.navbar?.breadcrumbs === 'auto' ? {
+            ...(req.user && adminizer.config.navbar?.breadcrumbs === 'auto' ? {
                 breadcrumbs: async () => {
                     try {
-                        const crumbs = await adminizer.adminLinkHandler.locate(req.user, req.originalUrl || req.url, menu);
+                        const menu = await resolveMenu();
+                        const crumbs = await adminizer.adminLinkHandler.locate(req.user, req.originalUrl || req.url, menu ?? undefined);
                         return crumbs.map((crumb) => ({ ...crumb, title: req.i18n.__(crumb.title) }));
                     }
                     catch (error) {
@@ -224,6 +247,9 @@ export function bindInertia(adminizer) {
         });
         next();
     });
+    // Pages declared to belong to a layout context the user may not enter are
+    // blocked here, before any route; `req.user` is known by now.
+    adminizer.app.use(adminizer.contextHandler.guard());
 }
 function checkAuth(req, adminizer) {
     let locale = "";