@betterportal/config-manager 10.1.61 → 10.1.63

package/lib/plugins/service-betterportal-config-manager/adminApi.js

@@ -1,5 +1,5 @@
 import * as av from "anyvali";
-import { AppAuthRoleSchema, eventHeaders, htmlResponse, jsonResponse, resolveEmbeddedRequestContext, signServiceConfigTicket, uuidv7, BetterPortalThemeConfigSchema } from "@betterportal/framework";
+import { AppAuthRoleSchema, eventHeaders, htmlResponse, jsonResponse, resolveEmbeddedRequestContext, signServiceConfigTicket, uuidv7, BetterPortalMenuItemSchema, BetterPortalThemeConfigSchema } from "@betterportal/framework";
 import { generateApiKey, hashApiKey } from "./storage/index.js";
 import { getManifestCache } from "./syncApi.js";
 import { apiRoutePath, appRoutePatternKey, isApiRoute, pageRoutePath } from "./routeMounts.js";
@@ -90,6 +90,19 @@ function requiredRouteString(body, key, label) {
         return { error: `${label} is required.` };
     return { value };
 }
+function normalizeMenuItem(raw) {
+    const item = raw && typeof raw === "object" ? raw : {};
+    return BetterPortalMenuItemSchema.parse({
+        id: typeof item.id === "string" ? item.id : uuidv7(),
+        type: item.type === "group" ? "group" : "link",
+        title: typeof item.title === "string" ? item.title : undefined,
+        icon: typeof item.icon === "string" ? item.icon : undefined,
+        routeId: typeof item.routeId === "string" ? item.routeId : undefined,
+        href: typeof item.href === "string" ? item.href : undefined,
+        enabled: item.enabled !== false,
+        children: Array.isArray(item.children) ? item.children.map(normalizeMenuItem) : []
+    });
+}
 function routesReloadPath(appId, apiServiceId) {
     return `/routes?appId=${encodeURIComponent(appId)}${apiServiceId ? `&apiServiceId=${encodeURIComponent(apiServiceId)}` : ""}`;
 }
@@ -163,15 +176,13 @@ function validateRouteParamMapping(appPath, servicePath, fixedParams, paramsSche
     }
     return undefined;
 }
-function routeMethodsFromManifest(methods) {
-    const normalized = (methods ?? []).filter((method) => method === "GET" || method === "POST" || method === "PUT" || method === "PATCH" || method === "DELETE" || method === "OPTIONS");
-    return normalized.length ? normalized : ["GET"];
-}
 function hasPageRenderer(view) {
-    const renderers = view.html?.renderers;
-    if (!renderers)
-        return view.renderable !== false;
-    return Object.values(renderers).some((renderer) => Array.isArray(renderer.renderModes) && renderer.renderModes.includes("page"));
+    return (view.operations ?? []).some((operation) => {
+        if (operation.method !== "GET" || operation.renderable === false)
+            return false;
+        const renderers = operation.html?.renderers;
+        return renderers && Object.values(renderers).some((renderer) => Array.isArray(renderer.renderModes) && renderer.renderModes.includes("page"));
+    });
 }
 function appMatchesTenantUrl(app, tenantUrl) {
     let host = "";
@@ -279,21 +290,22 @@ function automationServiceCatalog(config, appDef) {
                     ...resource,
                     url: `${service.url.replace(/\/+$/, "")}/.well-known/bp/resources/${encodeURIComponent(resource.id)}`
                 })),
-                actions: Object.values(manifest?.viewIndex ?? {}).map((view) => ({
+                actions: Object.values(manifest?.viewIndex ?? {}).flatMap((view) => view.operations.map((operation) => ({
                     viewId: view.viewId,
+                    operationId: operation.operationId,
                     path: view.path,
-                    methods: view.methods,
-                    title: view.viewId,
-                    renderable: view.renderable,
-                    permissions: view.permissions,
-                    role: view.role,
-                    chrome: view.chrome,
-                    dependencies: view.dependencies,
-                    schemas: view.schemas,
-                    raw: view.raw === true,
-                    apiContracts: view.apiContracts,
-                    demoScenarios: view.demoScenarios
-                }))
+                    method: operation.method,
+                    title: operation.title,
+                    renderable: operation.renderable,
+                    permissions: operation.permissions,
+                    role: operation.role,
+                    chrome: operation.chrome,
+                    dependencies: operation.dependencies,
+                    schemas: operation.schemas,
+                    raw: operation.raw === true,
+                    apiContracts: operation.apiContracts,
+                    demoScenarios: operation.demoScenarios
+                })))
             };
         })
     };
@@ -320,7 +332,7 @@ export function renderAutomationLlmsApi(catalog) {
         if (service.actions.length === 0)
             lines.push("No synced actions.", "");
         for (const action of service.actions) {
-            lines.push(`#### ${action.title}`, "", `- View ID: \`${action.viewId}\``, `- Methods: ${action.methods.map((method) => `\`${method}\``).join(", ")}`, `- URL: ${base}${action.path}`, `- Renderable: ${action.renderable ? "yes" : "no"}`, `- Required permissions: \`${JSON.stringify(action.permissions)}\``, "");
+            lines.push(`#### ${action.title}`, "", `- View ID: \`${action.viewId}\``, `- Operation ID: \`${action.operationId}\``, `- Method: \`${action.method}\``, `- URL: ${base}${action.path}`, `- Renderable: ${action.renderable ? "yes" : "no"}`, `- Required permissions: \`${JSON.stringify(action.permissions)}\``, "");
             if (action.schemas)
                 lines.push("```json", JSON.stringify(action.schemas, null, 2), "```", "");
             if (action.demoScenarios.length)
@@ -336,8 +348,14 @@ function parseRouteCreateBody(body) {
     const viewId = requiredRouteString(body, "viewId", "View");
     if (viewId.error)
         return { error: viewId.error };
+    const operationId = requiredRouteString(body, "operationId", "Operation");
+    if (operationId.error)
+        return { error: operationId.error };
     const manifestView = getManifestCache().get(serviceId.value)?.viewIndex[viewId.value];
-    const renderable = manifestView?.renderable !== false;
+    const manifestOperation = manifestView?.operations.find((operation) => operation.operationId === operationId.value);
+    if (manifestView && !manifestOperation)
+        return { error: "Selected operation is not available for this view." };
+    const renderable = manifestOperation?.method === "GET" && manifestOperation.renderable === true;
     const manifest = getManifestCache().get(serviceId.value);
     const servicePathVariant = trimmedString(body, "servicePathVariant") ?? manifestView?.path ?? `/${viewId.value}`;
     if (manifestView && ![manifestView.path, ...manifestView.pathVariants].includes(servicePathVariant)) {
@@ -357,7 +375,7 @@ function parseRouteCreateBody(body) {
     const mappingError = validateRouteParamMapping(path.value, serviceRoutePath, fixedParams, manifestView?.paramsSchema);
     if (mappingError)
         return { error: mappingError };
-    const title = renderable ? requiredRouteString(body, "title", "Display title") : { value: manifestView?.viewId ?? viewId.value };
+    const title = renderable ? requiredRouteString(body, "title", "Display title") : { value: manifestOperation?.title ?? operationId.value };
     if (title.error)
         return { error: title.error };
     const route = {
@@ -369,7 +387,7 @@ function parseRouteCreateBody(body) {
         ...(Object.keys(fixedParams).length > 0 ? { fixedParams } : {}),
         title: title.value,
         enabled: true,
-        methods: routeMethodsFromManifest(manifestView?.methods)
+        operations: [operationId.value]
     };
     if (manifestView?.path)
         route.targetPath = serviceRoutePath;
@@ -383,7 +401,7 @@ function serviceRouteTargetKey(route) {
         ?? route.targetPath
         ?? getManifestCache().get(route.serviceId)?.viewIndex[route.viewId]?.path;
     return servicePath
-        ? `${route.serviceId}\u0000${route.viewId}\u0000${appRoutePatternKey(servicePath)}`
+        ? `${route.serviceId}\u0000${route.viewId}\u0000${[...route.operations].sort().join(",")}\u0000${appRoutePatternKey(servicePath)}`
         : undefined;
 }
 function hasDuplicateServiceRouteTarget(appDef, route, excludeRouteId) {
@@ -453,22 +471,26 @@ function addRouteDependencies(appDef, route) {
     const view = manifest?.viewIndex[route.viewId];
     if (!manifest || !view)
         return;
-    for (const dependencyViewId of view.dependencies) {
-        const dependency = manifest.viewIndex[dependencyViewId];
+    const operations = new Map(Object.values(manifest.viewIndex).flatMap((candidateView) => candidateView.operations.map((operation) => [operation.operationId, { view: candidateView, operation }])));
+    const dependencies = view.operations
+        .filter((operation) => route.operations.includes(operation.operationId))
+        .flatMap((operation) => operation.dependencies);
+    for (const dependencyOperationId of dependencies) {
+        const dependency = operations.get(dependencyOperationId);
         if (!dependency)
             continue;
-        if (appDef.routes.some((candidate) => candidate.serviceId === route.serviceId && candidate.viewId === dependencyViewId))
+        if (appDef.routes.some((candidate) => candidate.serviceId === route.serviceId && candidate.operations.includes(dependencyOperationId)))
             continue;
         appDef.routes.push({
             id: uuidv7(),
             kind: "api",
-            path: apiRoutePath(manifest.serviceId, dependency.path),
+            path: apiRoutePath(manifest.serviceId, dependency.view.path),
             serviceId: route.serviceId,
-            viewId: dependencyViewId,
-            targetPath: dependency.path,
-            title: dependency.viewId,
+            viewId: dependency.view.viewId,
+            targetPath: dependency.view.path,
+            title: dependency.operation.title,
             enabled: true,
-            methods: routeMethodsFromManifest(dependency.methods)
+            operations: [dependencyOperationId]
         });
     }
 }
@@ -1527,16 +1549,16 @@ export function registerAdminApiRoutes(app, store, cpState) {
             type: av.literal("auth"),
             mutation: av.object({
                 roles: av.array(AppAuthRoleSchema)
-            }, { unknownKeys: "strip" })
-        }, { unknownKeys: "strip" }),
+            })
+        }),
         av.object({
             tenantId: av.string().minLength(1),
             appId: av.string().minLength(1),
             type: av.literal("theme"),
             mutation: av.object({
                 themeConfig: BetterPortalThemeConfigSchema
-            }, { unknownKeys: "strip" })
-        }, { unknownKeys: "strip" })
+            })
+        })
     ]);
     const getAppOr404 = async (appId) => {
         const config = await store.loadConfig();
@@ -1979,10 +2001,19 @@ export function registerAdminApiRoutes(app, store, cpState) {
                 return validationError(event, "View is required.");
             route.viewId = viewId;
         }
+        if (body.operationId !== undefined) {
+            const operationId = trimmedString(body, "operationId");
+            if (!operationId)
+                return validationError(event, "Operation is required.");
+            route.operations = [operationId];
+        }
         const manifest = getManifestCache().get(route.serviceId);
         const manifestView = manifest?.viewIndex[route.viewId];
         if (manifestView) {
-            const routeIdentityChanged = body.serviceId !== undefined || body.viewId !== undefined;
+            const manifestOperation = manifestView.operations.find((operation) => route.operations.includes(operation.operationId));
+            if (!manifestOperation)
+                return validationError(event, "Selected operation is not available for this view.");
+            const routeIdentityChanged = body.serviceId !== undefined || body.viewId !== undefined || body.operationId !== undefined;
             const requestedServicePath = trimmedString(body, "servicePathVariant")
                 ?? (routeIdentityChanged ? undefined : route.servicePathVariant)
                 ?? manifestView.path;
@@ -1993,7 +2024,8 @@ export function registerAdminApiRoutes(app, store, cpState) {
             if (servicePathError)
                 return validationError(event, servicePathError);
             const submittedFixed = fixedParamsFromBody(body);
-            const mappedAppPath = manifestView.renderable === false
+            const pageRenderable = manifestOperation.method === "GET" && manifestOperation.renderable;
+            const mappedAppPath = !pageRenderable
                 ? apiRoutePath(manifest?.serviceId ?? route.serviceId, requestedServicePath)
                 : route.path;
             const appParams = new Set(routeParamNames(mappedAppPath));
@@ -2009,12 +2041,11 @@ export function registerAdminApiRoutes(app, store, cpState) {
                 route.fixedParams = fixedParams;
             else
                 delete route.fixedParams;
-            route.methods = routeMethodsFromManifest(manifestView.methods);
             route.targetPath = requestedServicePath;
-            if (manifestView.renderable === false) {
+            if (!pageRenderable) {
                 route.kind = "api";
                 route.path = apiRoutePath(manifest?.serviceId ?? route.serviceId, requestedServicePath);
-                route.title = manifestView.viewId;
+                route.title = manifestOperation.title;
                 delete route.query;
             }
             else {
@@ -2030,7 +2061,8 @@ export function registerAdminApiRoutes(app, store, cpState) {
         }
         if (body.query !== undefined) {
             const query = trimmedString(body, "query");
-            if (isApiRoute(route, manifestView?.renderable))
+            const renderable = manifestView?.operations.some((operation) => route.operations.includes(operation.operationId) && operation.method === "GET" && operation.renderable);
+            if (isApiRoute(route, renderable))
                 delete route.query;
             else if (query)
                 route.query = query.replace(/^\?+/, "");
@@ -2041,7 +2073,8 @@ export function registerAdminApiRoutes(app, store, cpState) {
             const title = trimmedString(body, "title");
             if (!title)
                 return validationError(event, "Display title is required.");
-            if (!isApiRoute(route, manifestView?.renderable))
+            const renderable = manifestView?.operations.some((operation) => route.operations.includes(operation.operationId) && operation.method === "GET" && operation.renderable);
+            if (!isApiRoute(route, renderable))
                 route.title = title;
         }
         if (body.enabled !== undefined)
@@ -2111,19 +2144,7 @@ export function registerAdminApiRoutes(app, store, cpState) {
         const appDef = config.apps.find((a) => a.id === appId);
         if (!appDef)
             return jsonResponse({ error: "App not found" }, 404);
-        appDef.menu = items.map((raw) => {
-            const item = raw && typeof raw === "object" ? raw : {};
-            return {
-                id: typeof item.id === "string" ? item.id : uuidv7(),
-                type: item.type === "group" ? "group" : "link",
-                title: typeof item.title === "string" ? item.title : undefined,
-                icon: typeof item.icon === "string" ? item.icon : undefined,
-                routeId: typeof item.routeId === "string" ? item.routeId : undefined,
-                href: typeof item.href === "string" ? item.href : undefined,
-                enabled: item.enabled !== false,
-                children: Array.isArray(item.children) ? item.children : []
-            };
-        });
+        appDef.menu = items.map(normalizeMenuItem);
         await store.saveConfig(config);
         return jsonResponse({ ok: true });
     });
@@ -2196,27 +2217,27 @@ export function registerAdminApiRoutes(app, store, cpState) {
         let serviceId;
         let capabilities = [];
         let serviceRoutes = [];
-        let viewMeta = new Map();
-        let dependencyViewIds = new Set();
+        let dependencyOperationIds = new Set();
         const schemaText = typeof body.schema === "string" ? body.schema : "";
         if (schemaText) {
             try {
                 const schema = JSON.parse(schemaText);
                 serviceId = schema.manifest?.pluginId;
                 capabilities = Array.isArray(schema.manifest?.capabilities) ? schema.manifest.capabilities.filter((value) => typeof value === "string") : [];
-                serviceRoutes = schema.routes ?? [];
                 const manifestViews = schema.manifest?.views ?? [];
-                dependencyViewIds = new Set(manifestViews.flatMap((view) => Array.isArray(view.dependencies)
-                    ? view.dependencies.filter((value) => typeof value === "string")
+                dependencyOperationIds = new Set(manifestViews.flatMap((view) => (view.operations ?? []).flatMap((operation) => Array.isArray(operation.dependencies)
+                    ? operation.dependencies.filter((value) => typeof value === "string")
+                    : [])));
+                serviceRoutes = manifestViews.flatMap((view) => (view.operations ?? []).flatMap((operation) => typeof operation.operationId === "string"
+                    ? [{
+                            viewId: view.viewId,
+                            path: view.path ?? `/${view.viewId}`,
+                            operationId: operation.operationId,
+                            title: typeof operation.title === "string" ? operation.title : view.title,
+                            renderable: operation.renderable === true,
+                            pageRenderable: operation.method === "GET" && hasPageRenderer({ ...view, operations: [operation] })
+                        }]
                     : []));
-                viewMeta = new Map(manifestViews.map((v) => [v.viewId, {
-                        title: v.title,
-                        renderable: v.renderable !== false,
-                        pageRenderable: hasPageRenderer(v),
-                        methods: Array.isArray(v.methods)
-                            ? v.methods.filter((value) => typeof value === "string")
-                            : []
-                    }]));
             }
             catch { /* malformed schema - register without routes */ }
         }
@@ -2246,47 +2267,51 @@ export function registerAdminApiRoutes(app, store, cpState) {
                 const existingPaths = new Set(appDef.routes.map((r) => r.path));
                 for (const r of serviceRoutes) {
                     const routeServiceId = serviceId ?? newServiceId;
-                    const meta = viewMeta.get(r.viewId);
-                    const renderable = meta?.renderable ?? r.renderable !== false;
-                    const mountPath = renderable
+                    const mountPath = r.pageRenderable
                         ? pageRoutePath(routeServiceId, r.path)
                         : apiRoutePath(routeServiceId, r.path);
-                    if (existingPaths.has(mountPath))
+                    if (r.pageRenderable && existingPaths.has(mountPath))
+                        continue;
+                    if (appDef.routes.some((route) => route.serviceId === newServiceId && route.operations.includes(r.operationId)))
                         continue;
                     const routeId = uuidv7();
-                    const routeTitle = meta?.title ?? r.viewId;
+                    const routeTitle = r.title;
                     appDef.routes.push({
                         id: routeId,
-                        kind: renderable ? "page" : "api",
+                        kind: r.pageRenderable ? "page" : "api",
                         path: mountPath,
                         serviceId: newServiceId,
                         viewId: r.viewId,
                         targetPath: r.path,
                         title: routeTitle,
-                        enabled: renderable || dependencyViewIds.has(r.viewId),
-                        methods: routeMethodsFromManifest(r.methods)
+                        enabled: r.pageRenderable || dependencyOperationIds.has(r.operationId),
+                        operations: [r.operationId]
                     });
-                    existingPaths.add(mountPath);
-                    if (meta?.pageRenderable === true && !isApiRoute({ kind: renderable ? "page" : "api", path: mountPath }, renderable)) {
+                    if (r.pageRenderable)
+                        existingPaths.add(mountPath);
+                    if (r.pageRenderable && !isApiRoute({ kind: "page", path: mountPath }, true)) {
                         groupChildren.push({
                             id: uuidv7(),
                             type: "link",
                             title: routeTitle,
                             routeId,
-                            enabled: true
+                            enabled: true,
+                            serviceStatus: "show",
+                            authStatus: "show",
+                            children: []
                         });
                     }
                 }
                 if (groupChildren.length > 0) {
-                    const menu = (appDef.menu ?? []);
-                    menu.push({
+                    appDef.menu.push({
                         id: groupId,
                         type: "group",
                         title,
                         enabled: true,
+                        serviceStatus: "show",
+                        authStatus: "show",
                         children: groupChildren
                     });
-                    appDef.menu = menu;
                 }
             }
         }