@nocobase/plugin-flow-engine 2.2.0-beta.6 → 2.2.0-beta.8

package/dist/server/flow-surfaces/service.js

@@ -690,6 +690,7 @@ function assertNoFlowSurfaceIdTitleFieldSettings(value, options = {}) {
   visit(value, options.basePath || []);
 }
 const DEFAULT_ADMIN_UI_LAYOUT_UID = "admin-layout-model";
+const MOBILE_UI_LAYOUT_TYPE = "mobile";
 class FlowSurfacesService {
   constructor(plugin) {
     this.plugin = plugin;
@@ -923,12 +924,12 @@ class FlowSurfacesService {
       transaction
     });
   }
-  async findMenuGroupRoutesByTitle(title, transaction) {
+  async findMenuGroupRoutesByTitle(title, transaction, layoutUid) {
     const normalizedTitle = String(title || "").trim();
     if (!normalizedTitle) {
       return [];
     }
-    return import_lodash.default.castArray(
+    const routes = import_lodash.default.castArray(
       await this.db.getRepository("desktopRoutes").find({
         filter: {
           type: "group",
@@ -937,6 +938,18 @@ class FlowSurfacesService {
         transaction
       })
     );
+    const layoutUidFilter = await this.resolveDesktopRouteLayoutUidFilter(layoutUid, transaction);
+    if (!layoutUidFilter.length || !this.hasDesktopRouteUiLayoutsRelation()) {
+      return routes;
+    }
+    const matchedRoutes = [];
+    for (const route of routes) {
+      const routeLayoutUids = await this.readDesktopRouteUiLayoutUids(this.readRouteField(route, "id"), transaction);
+      if (import_lodash.default.intersection(routeLayoutUids, layoutUidFilter).length) {
+        matchedRoutes.push(route);
+      }
+    }
+    return matchedRoutes;
   }
   routeParentIdMatches(routeParentId, parentId) {
     if (import_lodash.default.isNil(routeParentId) && import_lodash.default.isNil(parentId)) {
@@ -944,28 +957,42 @@ class FlowSurfacesService {
     }
     return String(routeParentId ?? "") === String(parentId ?? "");
   }
-  async findMenuGroupRoutesByParentIdAndTitle(parentId, title, transaction) {
-    const routes = await this.findMenuGroupRoutesByTitle(title, transaction);
+  async findMenuGroupRoutesByParentIdAndTitle(parentId, title, transaction, layoutUid) {
+    const routes = await this.findMenuGroupRoutesByTitle(title, transaction, layoutUid);
     return routes.filter(
       (route) => this.routeParentIdMatches(this.readRouteField(route, "parentId") ?? null, parentId)
     );
   }
-  async findFlowPageRoutesByParentIdAndTitle(parentId, title, transaction) {
+  async findFlowPageRoutesByParentIdAndTitle(parentId, title, transaction, layoutUid) {
     const normalizedTitle = String(title || "").trim();
-    const normalizedParentId = String(parentId ?? "").trim();
-    if (!normalizedTitle || !normalizedParentId) {
+    if (!normalizedTitle) {
       return [];
     }
-    return import_lodash.default.castArray(
+    const routes = import_lodash.default.castArray(
       await this.db.getRepository("desktopRoutes").find({
-        filter: {
+        filter: (0, import_service_utils.buildDefinedPayload)({
           type: "flowPage",
           title: normalizedTitle,
-          parentId: normalizedParentId
-        },
+          parentId: import_lodash.default.isNil(parentId) ? void 0 : String(parentId)
+        }),
         transaction
       })
     );
+    const layoutUidFilter = await this.resolveDesktopRouteLayoutUidFilter(layoutUid, transaction);
+    const layoutMatchedRoutes = [];
+    if (!layoutUidFilter.length || !this.hasDesktopRouteUiLayoutsRelation()) {
+      layoutMatchedRoutes.push(...routes);
+    } else {
+      for (const route of routes) {
+        const routeLayoutUids = await this.readDesktopRouteUiLayoutUids(this.readRouteField(route, "id"), transaction);
+        if (import_lodash.default.intersection(routeLayoutUids, layoutUidFilter).length) {
+          layoutMatchedRoutes.push(route);
+        }
+      }
+    }
+    return layoutMatchedRoutes.filter(
+      (route) => this.routeParentIdMatches(this.readRouteField(route, "parentId") ?? null, parentId)
+    );
   }
   async assertMenuParentIsGroup(parentMenuRouteId, transaction) {
     if (import_lodash.default.isNil(parentMenuRouteId)) {
@@ -1071,6 +1098,29 @@ class FlowSurfacesService {
     });
     return defaultLayout ? [DEFAULT_ADMIN_UI_LAYOUT_UID] : [];
   }
+  async findDesktopRouteUiLayoutByUid(layoutUid, transaction) {
+    const normalizedLayoutUid = this.normalizeExplicitDesktopRouteLayoutUid(layoutUid);
+    if (!normalizedLayoutUid || !this.hasDesktopRouteUiLayoutsRelation()) {
+      return null;
+    }
+    return this.db.getRepository("uiLayouts").findOne({
+      filter: {
+        uid: normalizedLayoutUid
+      },
+      transaction
+    });
+  }
+  async getDesktopRouteUiLayoutTypeByUid(layoutUid, transaction) {
+    var _a;
+    const uiLayout = await this.findDesktopRouteUiLayoutByUid(layoutUid, transaction);
+    return String(((_a = uiLayout == null ? void 0 : uiLayout.get) == null ? void 0 : _a.call(uiLayout, "layoutType")) || (uiLayout == null ? void 0 : uiLayout.layoutType) || "").trim() || void 0;
+  }
+  async isMobileDesktopRouteUiLayoutUid(layoutUid, transaction) {
+    if (!layoutUid) {
+      return false;
+    }
+    return await this.getDesktopRouteUiLayoutTypeByUid(layoutUid, transaction) === MOBILE_UI_LAYOUT_TYPE;
+  }
   async resolveInheritedDesktopRouteUiLayoutUids(parentRoute, transaction) {
     const parentRouteId = this.readRouteField(parentRoute, "id");
     if (!import_lodash.default.isNil(parentRouteId)) {
@@ -1081,6 +1131,86 @@ class FlowSurfacesService {
     }
     return this.resolveDefaultDesktopRouteUiLayoutUids(transaction);
   }
+  normalizeExplicitDesktopRouteLayoutUid(value) {
+    const normalized = String(value || "").trim();
+    return normalized || void 0;
+  }
+  normalizeDesktopRouteLayoutUidFilter(value) {
+    return import_lodash.default.uniq(
+      import_lodash.default.castArray(value).map((item) => this.normalizeExplicitDesktopRouteLayoutUid(item)).filter(Boolean)
+    );
+  }
+  async resolveDesktopRouteLayoutUidFilter(value, transaction) {
+    const explicitLayoutUids = this.normalizeDesktopRouteLayoutUidFilter(value);
+    if (explicitLayoutUids.length) {
+      return explicitLayoutUids;
+    }
+    return this.resolveDefaultDesktopRouteUiLayoutUids(transaction);
+  }
+  async assertEnabledDesktopRouteUiLayoutUid(layoutUid, actionName, path, transaction) {
+    if (!this.hasDesktopRouteUiLayoutsRelation()) {
+      (0, import_errors.throwBadRequest)(`flowSurfaces ${actionName} ${path} requires plugin-ui-layout desktop route relation support`, {
+        ruleId: "navigation-layout-unsupported",
+        path,
+        details: {
+          layoutUid
+        }
+      });
+    }
+    const uiLayout = await this.db.getRepository("uiLayouts").findOne({
+      filter: {
+        uid: layoutUid,
+        enabled: true
+      },
+      transaction
+    });
+    if (!uiLayout) {
+      (0, import_errors.throwBadRequest)(`flowSurfaces ${actionName} ${path} must reference an enabled ui layout`, {
+        ruleId: "navigation-layout-not-found",
+        path,
+        details: {
+          layoutUid
+        }
+      });
+    }
+  }
+  async assertDesktopRouteBelongsToUiLayout(actionName, route, layoutUid, path, transaction) {
+    const normalizedLayoutUid = this.normalizeExplicitDesktopRouteLayoutUid(layoutUid);
+    if (!normalizedLayoutUid || !route) {
+      return;
+    }
+    const routeId = this.readRouteField(route, "id");
+    const routeLayoutUids = await this.readDesktopRouteUiLayoutUids(routeId, transaction);
+    if (routeLayoutUids.includes(normalizedLayoutUid)) {
+      return;
+    }
+    (0, import_errors.throwBadRequest)(`flowSurfaces ${actionName} ${path} does not belong to ui layout '${normalizedLayoutUid}'`, {
+      ruleId: "navigation-route-layout-mismatch",
+      path,
+      details: {
+        routeId,
+        layoutUid: normalizedLayoutUid,
+        routeLayoutUids
+      }
+    });
+  }
+  async resolveRequestedDesktopRouteUiLayoutUids(values, parentRoute, actionName, transaction) {
+    const layoutUid = this.normalizeExplicitDesktopRouteLayoutUid(values.layoutUid);
+    if (layoutUid) {
+      await this.assertEnabledDesktopRouteUiLayoutUid(layoutUid, actionName, "values.layoutUid", transaction);
+      if (parentRoute) {
+        await this.assertDesktopRouteBelongsToUiLayout(
+          actionName,
+          parentRoute,
+          layoutUid,
+          "values.parentMenuRouteId",
+          transaction
+        );
+      }
+      return [layoutUid];
+    }
+    return this.resolveInheritedDesktopRouteUiLayoutUids(parentRoute, transaction);
+  }
   async setDesktopRouteUiLayouts(routeId, uiLayoutUids, transaction) {
     const relationRouteId = this.normalizeDesktopRouteRelationId(routeId);
     if (import_lodash.default.isUndefined(relationRouteId) || !uiLayoutUids.length || !this.hasDesktopRouteUiLayoutsRelation()) {
@@ -1181,8 +1311,19 @@ class FlowSurfacesService {
   async createFlowMenuGroup(values, transaction) {
     const parentRoute = await this.assertMenuParentIsGroup(values.parentMenuRouteId, transaction);
     const parentId = this.readRouteField(parentRoute, "id") ?? null;
+    const routeUiLayoutUids = await this.resolveRequestedDesktopRouteUiLayoutUids(
+      values,
+      parentRoute,
+      "createMenu",
+      transaction
+    );
     const title = String(values.title || "").trim();
-    const existingGroups = await this.findMenuGroupRoutesByParentIdAndTitle(parentId, title, transaction);
+    const existingGroups = await this.findMenuGroupRoutesByParentIdAndTitle(
+      parentId,
+      title,
+      transaction,
+      routeUiLayoutUids
+    );
     if (existingGroups.length === 1) {
       return this.buildMenuResult(existingGroups[0]);
     }
@@ -1222,7 +1363,7 @@ class FlowSurfacesService {
     });
     await this.attachDesktopRouteUiLayoutsToRouteAndChildren(
       this.readRouteField(route, "id"),
-      await this.resolveInheritedDesktopRouteUiLayoutUids(parentRoute, transaction),
+      routeUiLayoutUids,
       transaction
     );
     return this.buildMenuResult(route);
@@ -1230,6 +1371,12 @@ class FlowSurfacesService {
   async createFlowMenuItem(values, transaction) {
     var _a;
     const parentRoute = await this.assertMenuParentIsGroup(values.parentMenuRouteId, transaction);
+    const routeUiLayoutUids = await this.resolveRequestedDesktopRouteUiLayoutUids(
+      values,
+      parentRoute,
+      "createMenu",
+      transaction
+    );
     this.assertVisibleNavigationIcon("createMenu", "values", values);
     const pageSchemaUid = values.pageSchemaUid || (0, import_utils.uid)();
     const menuSchemaUid = (0, import_utils.uid)();
@@ -1276,7 +1423,7 @@ class FlowSurfacesService {
     });
     await this.attachDesktopRouteUiLayoutsToRouteAndChildren(
       this.readRouteField(createdRoute, "id"),
-      await this.resolveInheritedDesktopRouteUiLayoutUids(parentRoute, transaction),
+      routeUiLayoutUids,
       transaction
     );
     const route = await desktopRoutes.findOne({
@@ -1313,7 +1460,7 @@ class FlowSurfacesService {
     });
   }
   sanitizePublicCreateMenuValues(values) {
-    return import_lodash.default.pick(values, ["title", "type", "icon", "tooltip", "hideInMenu", "parentMenuRouteId"]);
+    return import_lodash.default.pick(values, ["title", "type", "layoutUid", "icon", "tooltip", "hideInMenu", "parentMenuRouteId"]);
   }
   async loadRouteBackedPageStructure(route, transaction) {
     const routeId = this.readRouteField(route, "id");
@@ -3223,7 +3370,13 @@ class FlowSurfacesService {
     if (!groupTitle) {
       return document;
     }
-    const matchedRoutes = await this.findMenuGroupRoutesByParentIdAndTitle(null, groupTitle, transaction);
+    const layoutUid = this.normalizeExplicitDesktopRouteLayoutUid(document.navigation.layoutUid);
+    const matchedRoutes = await this.findMenuGroupRoutesByParentIdAndTitle(
+      null,
+      groupTitle,
+      transaction,
+      layoutUid || await this.resolveDefaultDesktopRouteUiLayoutUids(transaction)
+    );
     if (!matchedRoutes.length) {
       return document;
     }
@@ -3248,29 +3401,89 @@ class FlowSurfacesService {
       }
     };
   }
+  async normalizeApplyBlueprintCreateMobileNavigation(document, transaction) {
+    var _a;
+    if (document.mode !== "create") {
+      return document;
+    }
+    const layoutUid = this.normalizeExplicitDesktopRouteLayoutUid((_a = document.navigation) == null ? void 0 : _a.layoutUid);
+    if (!await this.isMobileDesktopRouteUiLayoutUid(layoutUid, transaction)) {
+      return document;
+    }
+    return {
+      ...document,
+      navigation: (0, import_service_utils.buildDefinedPayload)({
+        ...document.navigation,
+        layoutUid,
+        group: void 0
+      })
+    };
+  }
+  async assertApplyBlueprintCreateNavigationLayout(document, transaction) {
+    var _a, _b, _c;
+    if (document.mode !== "create") {
+      return;
+    }
+    const layoutUid = this.normalizeExplicitDesktopRouteLayoutUid((_a = document.navigation) == null ? void 0 : _a.layoutUid);
+    if (!layoutUid) {
+      return;
+    }
+    await this.assertEnabledDesktopRouteUiLayoutUid(
+      layoutUid,
+      "applyBlueprint",
+      "values.navigation.layoutUid",
+      transaction
+    );
+    if (await this.isMobileDesktopRouteUiLayoutUid(layoutUid, transaction)) {
+      return;
+    }
+    const groupRouteId = (_c = (_b = document.navigation) == null ? void 0 : _b.group) == null ? void 0 : _c.routeId;
+    if (import_lodash.default.isNil(groupRouteId) || groupRouteId === "") {
+      return;
+    }
+    const groupRoute = await this.assertMenuParentIsGroup(groupRouteId, transaction);
+    await this.assertDesktopRouteBelongsToUiLayout(
+      "applyBlueprint",
+      groupRoute,
+      layoutUid,
+      "values.navigation.group.routeId",
+      transaction
+    );
+  }
   async resolveApplyBlueprintCreatePageIdentity(document, transaction) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f;
     if (document.mode !== "create") {
       return document;
     }
     const groupRouteId = (_b = (_a = document.navigation) == null ? void 0 : _a.group) == null ? void 0 : _b.routeId;
-    const pageTitle = String(((_c = document.page) == null ? void 0 : _c.title) || ((_e = (_d = document.navigation) == null ? void 0 : _d.item) == null ? void 0 : _e.title) || "").trim();
-    if (import_lodash.default.isNil(groupRouteId) || groupRouteId === "" || !pageTitle) {
+    const layoutUid = this.normalizeExplicitDesktopRouteLayoutUid((_c = document.navigation) == null ? void 0 : _c.layoutUid);
+    const pageTitle = String(((_d = document.page) == null ? void 0 : _d.title) || ((_f = (_e = document.navigation) == null ? void 0 : _e.item) == null ? void 0 : _f.title) || "").trim();
+    const hasGroupRouteId = !import_lodash.default.isNil(groupRouteId) && groupRouteId !== "";
+    if (!pageTitle || !hasGroupRouteId && !layoutUid) {
       return document;
     }
-    const matchedPages = await this.findFlowPageRoutesByParentIdAndTitle(groupRouteId, pageTitle, transaction);
+    const groupRoute = hasGroupRouteId ? await this.findMenuRouteById(groupRouteId, transaction) : null;
+    const layoutUidFilter = layoutUid || (groupRoute ? await this.resolveInheritedDesktopRouteUiLayoutUids(groupRoute, transaction) : void 0);
+    const matchedPages = await this.findFlowPageRoutesByParentIdAndTitle(
+      hasGroupRouteId ? groupRouteId : null,
+      pageTitle,
+      transaction,
+      layoutUidFilter
+    );
     if (!matchedPages.length) {
       return document;
     }
     if (matchedPages.length > 1) {
+      const locationLabel = hasGroupRouteId ? `under navigation.group.routeId '${groupRouteId}'` : `at the root of ui layout '${layoutUid}'`;
       (0, import_errors.throwBadRequest)(
-        `flowSurfaces applyBlueprint navigation.group.routeId '${groupRouteId}' already has ${matchedPages.length} flow pages titled '${pageTitle}'; pass target.pageSchemaUid explicitly before applyBlueprint`
+        `flowSurfaces applyBlueprint ${locationLabel} already has ${matchedPages.length} flow pages titled '${pageTitle}'; pass target.pageSchemaUid explicitly before applyBlueprint`
       );
     }
     const pageSchemaUid = String(this.readRouteField(matchedPages[0], "schemaUid") || "").trim();
     if (!pageSchemaUid) {
+      const locationLabel = hasGroupRouteId ? `under navigation.group.routeId '${groupRouteId}'` : `at the root of ui layout '${layoutUid}'`;
       (0, import_errors.throwBadRequest)(
-        `flowSurfaces applyBlueprint existing flow page '${pageTitle}' under navigation.group.routeId '${groupRouteId}' is missing schemaUid; pass target.pageSchemaUid explicitly before applyBlueprint`
+        `flowSurfaces applyBlueprint existing flow page '${pageTitle}' ${locationLabel} is missing schemaUid; pass target.pageSchemaUid explicitly before applyBlueprint`
       );
     }
     return {
@@ -3285,7 +3498,15 @@ class FlowSurfacesService {
   async prepareApplyBlueprintRequest(values, transaction, createdKanbanSortFields) {
     var _a;
     const initialDocument = (0, import_blueprint.prepareFlowSurfaceApplyBlueprintDocument)(values);
-    const groupResolvedDocument = await this.resolveApplyBlueprintCreateNavigationGroup(initialDocument, transaction);
+    await this.assertApplyBlueprintCreateNavigationLayout(initialDocument, transaction);
+    const mobileNormalizedDocument = await this.normalizeApplyBlueprintCreateMobileNavigation(
+      initialDocument,
+      transaction
+    );
+    const groupResolvedDocument = await this.resolveApplyBlueprintCreateNavigationGroup(
+      mobileNormalizedDocument,
+      transaction
+    );
     const document = await this.resolveApplyBlueprintCreatePageIdentity(groupResolvedDocument, transaction);
     await this.prepareApplyBlueprintKanbanBlocks(document, transaction, createdKanbanSortFields);
     const replaceTarget = document.mode === "replace" && document.target ? await this.resolveApplyBlueprintReplaceTargetInfo(document.target.pageSchemaUid, transaction) : void 0;
@@ -3942,7 +4163,8 @@ class FlowSurfacesService {
     await (0, import_authoring_validation.assertFlowSurfaceAuthoringPayload)("applyBlueprint", values, {
       transaction: options.transaction,
       enabledPackages,
-      findMenuGroupRoutesByTitle: (title, transaction) => this.findMenuGroupRoutesByTitle(title, transaction),
+      findMenuGroupRoutesByTitle: (title, transaction, layoutUid) => this.findMenuGroupRoutesByTitle(title, transaction, layoutUid),
+      getUiLayoutTypeByUid: (layoutUid, transaction) => this.getDesktopRouteUiLayoutTypeByUid(layoutUid, transaction),
       getCollection: (dataSourceKey, collectionName) => this.getCollection(dataSourceKey || "main", collectionName || "")
     });
   }
@@ -6026,6 +6248,11 @@ class FlowSurfacesService {
     const pageSchemaUid = this.readRouteField(route, "schemaUid");
     const structure = await this.loadRouteBackedPageStructure(route, transaction);
     let tabRoute = structure.tabRoutes[0];
+    const layoutUid = this.normalizeExplicitDesktopRouteLayoutUid(values.layoutUid);
+    if (layoutUid) {
+      await this.assertEnabledDesktopRouteUiLayoutUid(layoutUid, "createPage", "values.layoutUid", transaction);
+      await this.assertDesktopRouteBelongsToUiLayout("createPage", route, layoutUid, "values.menuRouteId", transaction);
+    }
     const routeUiLayoutUids = await this.ensureDesktopRouteUiLayouts(route, transaction);
     const routeOptions = this.readRouteOptions(route);
     if (!routeOptions[FLOW_SURFACE_MENU_BINDABLE_OPTION_KEY]) {
@@ -17244,13 +17471,20 @@ class FlowSurfacesService {
           description: changes.description,
           className: changes.className
         }),
-        stepParams: (0, import_service_utils.hasDefinedValue)(changes, ["code", "version"]) ? {
-          jsSettings: {
-            runJs: (0, import_service_utils.buildDefinedPayload)({
-              code: changes.code,
-              version: changes.version
-            })
-          }
+        stepParams: (0, import_service_utils.hasDefinedValue)(changes, ["code", "version", "showBlockCard"]) ? {
+          jsSettings: (0, import_service_utils.buildDefinedPayload)({
+            ...(0, import_service_utils.hasDefinedValue)(changes, ["code", "version"]) ? {
+              runJs: (0, import_service_utils.buildDefinedPayload)({
+                code: changes.code,
+                version: changes.version
+              })
+            } : {},
+            ...(0, import_service_utils.hasOwnDefined)(changes, "showBlockCard") ? {
+              showBlockCard: {
+                showBlockCard: changes.showBlockCard
+              }
+            } : {}
+          })
         } : void 0
       },
       options

package/dist/server/flow-surfaces/types.d.ts

@@ -45,7 +45,8 @@ export type FlowSurfaceConfigureOption = {
     type: FlowSurfaceConfigureOptionValueType;
     description?: string;
     enum?: Array<string | number | boolean>;
-    example?: any;
+    example?: unknown;
+    default?: unknown;
     supportsFlowContext?: boolean;
 };
 export type FlowSurfaceConfigureOptions = Record<string, FlowSurfaceConfigureOption>;

package/dist/swagger/flow-surfaces.d.ts

@@ -2635,6 +2635,10 @@ declare const _default: {
             FlowSurfaceApplyBlueprintNavigation: {
                 type: string;
                 properties: {
+                    layoutUid: {
+                        type: string;
+                        description: string;
+                    };
                     group: {
                         $ref: string;
                     };
@@ -3148,6 +3152,10 @@ declare const _default: {
                 type: string;
                 required: string[];
                 properties: {
+                    layoutUid: {
+                        type: string;
+                        description: string;
+                    };
                     title: {
                         type: string;
                     };
@@ -3270,6 +3278,10 @@ declare const _default: {
             FlowSurfaceCreatePageRequest: {
                 type: string;
                 properties: {
+                    layoutUid: {
+                        type: string;
+                        description: string;
+                    };
                     menuRouteId: {
                         oneOf: {
                             type: string;
@@ -6102,6 +6114,7 @@ declare const _default: {
                         };
                     };
                     example: {};
+                    default: {};
                     supportsFlowContext: {
                         type: string;
                     };

package/dist/swagger/flow-surfaces.examples.d.ts

@@ -668,6 +668,7 @@ export declare const flowSurfaceExamples: {
                 title: string;
                 description: string;
                 className: string;
+                showBlockCard: boolean;
                 version: string;
                 code: string;
             };
@@ -764,6 +765,7 @@ export declare const flowSurfaceExamples: {
             title: string;
             description: string;
             className: string;
+            showBlockCard: boolean;
             version: string;
             code: string;
         };
@@ -1068,6 +1070,7 @@ export declare const flowSurfaceExamples: {
         settings: {
             title: string;
             description: string;
+            showBlockCard: boolean;
             version: string;
             code: string;
         };

package/dist/swagger/flow-surfaces.examples.js

@@ -893,6 +893,7 @@ const flowSurfaceExamples = {
           title: "Custom hero",
           description: "Rendered by JS block runtime",
           className: "hero-shell",
+          showBlockCard: true,
           version: "1.0.0",
           code: "ctx.render('<div>Hello from JS block</div>');"
         }
@@ -996,6 +997,7 @@ const flowSurfaceExamples = {
       title: "Users hero",
       description: "Rendered from FlowSurfaces configure",
       className: "users-hero",
+      showBlockCard: true,
       version: "1.0.1",
       code: "ctx.render('<div>Users hero</div>');"
     }
@@ -1341,6 +1343,7 @@ const flowSurfaceExamples = {
     settings: {
       title: "Users banner",
       description: "Custom JS rendered banner",
+      showBlockCard: true,
       version: "1.0.0",
       code: "ctx.render('<div>Users banner</div>');"
     }

package/dist/swagger/flow-surfaces.js

@@ -623,7 +623,7 @@ const actionDocs = {
     tags: [FLOW_SURFACES_TAG],
     summary: "Apply a page blueprint to create or replace one Modern page",
     description: valuesCompatibilityNote(
-      `Accepts one simplified JSON page blueprint and compiles it to internal flow-surface operations. The public blueprint describes page structure (\`create\` or \`replace\`, page metadata, ordered tabs, blocks, fields, actions, inline popups, optional reusable assets) and optional top-level \`reaction.items[]\` for whole-page interaction authoring. Each reaction item targets an explicit local key / bind key produced by the same blueprint run. Only explicitly listed reaction items are written. \`rules: []\` clears the targeted slot. Repeating the same \`(type, target)\` reaction slot in one blueprint is invalid. In \`replace\`, reaction targets always bind to the newly produced blueprint result, not historical nodes from the previous page version; if a slot must exist in the resulting surface, include it explicitly instead of relying on omission. Localized reaction edits on an existing surface should use \`getReactionMeta\` + \`set*Rules\` instead of applying a whole page blueprint again. The request body is that page-document JSON object itself and must not be JSON-stringified. Wrong: \`{ "requestBody": "{\\"version\\":\\"1\\"}" }\`. Internal planning details stay hidden. In \`create\`, \`navigation.group.routeId\` has the highest priority when targeting an existing menu group. If \`routeId\` is present, applyBlueprint ignores \`title\`, \`icon\`, \`tooltip\`, and \`hideInMenu\` on \`navigation.group\`; applyBlueprint create mode does not mutate existing group metadata, so callers should use \`updateMenu\` separately when that is required. When \`routeId\` is omitted and \`navigation.group.title\` is provided, applyBlueprint reuses one existing same-title group when it is unique, creates a new group when none exists, and rejects ambiguous multi-match cases. Metadata such as \`icon\`, \`tooltip\`, and \`hideInMenu\` is used only when a new group is created and is ignored when an existing group is reused. \`replace\` uses \`target.pageSchemaUid\`, updates only the explicit page-level fields provided in \`page\`, maps blueprint tabs to existing route-backed tab slots by index, rewrites each slot in order, removes trailing old tabs, and appends extra new tabs when needed. Tab and block keys are optional in the public blueprint; omit them unless custom layout or cross-block targeting needs a stable in-document identifier. \`layout\` is only allowed on tabs and inline popup documents; blocks themselves do not accept a \`layout\` property. Public applyBlueprint blocks do not support generic \`form\`; use \`editForm\` or \`createForm\`. AI employee actions use \`type: "aiEmployee"\` plus public \`settings.username\`, \`workContext\`, \`tasks\`, \`auto\`, and \`style\`; work context may target \`self\` or a same-blueprint block key and is persisted as real Flow Model \`uid\` values. For JS blocks/fields/actions, \`script\` is a non-empty string asset key into \`assets.scripts\`; put inline JS in \`settings.code\` and \`settings.version\`. Direct \`table\` / \`list\` / \`gridCard\` / \`calendar\` / \`kanban\` blocks may omit \`defaultFilter\`; the backend generates one from live metadata with up to 4 scalar/filterable fields. Explicit values must contain at least the smaller of 3 and the collection eligible-field count, and values with more than 4 fields are truncated before persistence. A valid explicit or generated block-level value backfills the default \`filter\` action \`settings.defaultFilter\`; explicit filter-action \`settings.defaultFilter\` still wins. ${TREE_TABLE_RECORD_ACTION_DEFAULTS_NOTE} ${APPLY_BLUEPRINT_TREE_TABLE_TITLE_FIELD_NOTE} Inline popup documents may set \`popup.tryTemplate=true\` to ask the backend for the best compatible popup template before falling back to local popup content. Inline popup documents may also combine \`popup.tryTemplate\` with \`popup.saveAsTemplate={ name, description, local? }\`: a hit binds the matched template immediately and lets later inline popups in the same blueprint reuse that final bound template through \`popup.template={ local, mode }\`, while a miss requires explicit local \`popup.blocks\` so the fallback popup can be saved and reused. Custom \`edit\` popups that provide \`popup.blocks\` must include exactly one \`editForm\` block; that \`editForm\` may omit \`resource\` and then inherits the opener's current-record context. When layout is omitted, applyBlueprint auto-generates a simple top-to-bottom layout. When a \`replace\` run expands a page to multiple tabs while the current page still has \`enableTabs=false\`, callers must set \`page.enableTabs=true\` explicitly. The response hides execution internals and returns only the resolved page target and final surface readback.`
+      `Accepts one simplified JSON page blueprint and compiles it to internal flow-surface operations. The public blueprint describes page structure (\`create\` or \`replace\`, page metadata, ordered tabs, blocks, fields, actions, inline popups, optional reusable assets) and optional top-level \`reaction.items[]\` for whole-page interaction authoring. Each reaction item targets an explicit local key / bind key produced by the same blueprint run. Only explicitly listed reaction items are written. \`rules: []\` clears the targeted slot. Repeating the same \`(type, target)\` reaction slot in one blueprint is invalid. In \`replace\`, reaction targets always bind to the newly produced blueprint result, not historical nodes from the previous page version; if a slot must exist in the resulting surface, include it explicitly instead of relying on omission. Localized reaction edits on an existing surface should use \`getReactionMeta\` + \`set*Rules\` instead of applying a whole page blueprint again. The request body is that page-document JSON object itself and must not be JSON-stringified. Wrong: \`{ "requestBody": "{\\"version\\":\\"1\\"}" }\`. Internal planning details stay hidden. In \`create\`, \`navigation.layoutUid\` optionally scopes menu group reuse, duplicate page identity checks, and newly created routes to an enabled UI layout such as \`admin-layout-model\` or \`mobile-layout-model\`; when the target layout type is mobile, applyBlueprint ignores \`navigation.group\` and creates a root-level mobile tab page. When \`layoutUid\` is omitted, routes keep the existing admin/default inheritance behavior. In non-mobile \`create\`, \`navigation.group.routeId\` has the highest priority when targeting an existing menu group. If \`routeId\` is present, applyBlueprint ignores \`title\`, \`icon\`, \`tooltip\`, and \`hideInMenu\` on \`navigation.group\`; applyBlueprint create mode does not mutate existing group metadata, so callers should use \`updateMenu\` separately when that is required. When \`routeId\` is omitted and \`navigation.group.title\` is provided, applyBlueprint reuses one existing same-title group in the target layout when it is unique, creates a new group when none exists, and rejects ambiguous multi-match cases. Metadata such as \`icon\`, \`tooltip\`, and \`hideInMenu\` is used only when a new group is created and is ignored when an existing group is reused. \`replace\` uses \`target.pageSchemaUid\`, updates only the explicit page-level fields provided in \`page\`, maps blueprint tabs to existing route-backed tab slots by index, rewrites each slot in order, removes trailing old tabs, and appends extra new tabs when needed. Tab and block keys are optional in the public blueprint; omit them unless custom layout or cross-block targeting needs a stable in-document identifier. \`layout\` is only allowed on tabs and inline popup documents; blocks themselves do not accept a \`layout\` property. Public applyBlueprint blocks do not support generic \`form\`; use \`editForm\` or \`createForm\`. AI employee actions use \`type: "aiEmployee"\` plus public \`settings.username\`, \`workContext\`, \`tasks\`, \`auto\`, and \`style\`; work context may target \`self\` or a same-blueprint block key and is persisted as real Flow Model \`uid\` values. For JS blocks/fields/actions, \`script\` is a non-empty string asset key into \`assets.scripts\`; put inline JS in \`settings.code\` and \`settings.version\`. Direct \`table\` / \`list\` / \`gridCard\` / \`calendar\` / \`kanban\` blocks may omit \`defaultFilter\`; the backend generates one from live metadata with up to 4 scalar/filterable fields. Explicit values must contain at least the smaller of 3 and the collection eligible-field count, and values with more than 4 fields are truncated before persistence. A valid explicit or generated block-level value backfills the default \`filter\` action \`settings.defaultFilter\`; explicit filter-action \`settings.defaultFilter\` still wins. ${TREE_TABLE_RECORD_ACTION_DEFAULTS_NOTE} ${APPLY_BLUEPRINT_TREE_TABLE_TITLE_FIELD_NOTE} Inline popup documents may set \`popup.tryTemplate=true\` to ask the backend for the best compatible popup template before falling back to local popup content. Inline popup documents may also combine \`popup.tryTemplate\` with \`popup.saveAsTemplate={ name, description, local? }\`: a hit binds the matched template immediately and lets later inline popups in the same blueprint reuse that final bound template through \`popup.template={ local, mode }\`, while a miss requires explicit local \`popup.blocks\` so the fallback popup can be saved and reused. Custom \`edit\` popups that provide \`popup.blocks\` must include exactly one \`editForm\` block; that \`editForm\` may omit \`resource\` and then inherits the opener's current-record context. When layout is omitted, applyBlueprint auto-generates a simple top-to-bottom layout. When a \`replace\` run expands a page to multiple tabs while the current page still has \`enableTabs=false\`, callers must set \`page.enableTabs=true\` explicitly. The response hides execution internals and returns only the resolved page target and final surface readback.`
     ),
     requestBody: {
       required: true,
@@ -809,7 +809,7 @@ const actionDocs = {
     tags: [FLOW_SURFACES_TAG],
     summary: "Create a group menu or a bindable V2 menu item",
     description: valuesCompatibilityNote(
-      'Creates a FlowSurfaces menu node. `type="group"` creates a menu group. `type="item"` creates a menu item that can be bound to a modern page (v2), and automatically fills in the flowPage route, the default hidden tab route, and the RootPageModel anchor.'
+      'Creates a FlowSurfaces menu node. `type="group"` creates a menu group. `type="item"` creates a menu item that can be bound to a modern page (v2), and automatically fills in the flowPage route, the default hidden tab route, and the RootPageModel anchor. Optional `layoutUid` scopes the route to an enabled UI layout; omitted values keep the existing parent/default admin layout inheritance.'
     ),
     requestBody: requestBody("FlowSurfaceCreateMenuRequest", import_flow_surfaces.flowSurfaceExamples.createMenu),
     responses: responses("FlowSurfaceCreateMenuResult")
@@ -827,7 +827,7 @@ const actionDocs = {
     tags: [FLOW_SURFACES_TAG],
     summary: "Initialize a modern page for an existing bindable menu item",
     description: valuesCompatibilityNote(
-      "Initializes a modern page (v2) for an existing bindable menu item through `menuRouteId` first, and fills in the default BlockGridModel. In compatibility mode, if `menuRouteId` is omitted, the old behavior still applies and a top-level menu plus page will be created automatically. Before initialization, do not call page/tab lifecycle actions such as `addTab`, `updateTab`, `moveTab`, `removeTab`, or `destroyPage`."
+      "Initializes a modern page (v2) for an existing bindable menu item through `menuRouteId` first, and fills in the default BlockGridModel. Optional `layoutUid` asserts that the existing menu route belongs to the target UI layout; omitted values keep the existing parent/default admin layout inheritance. In compatibility mode, if `menuRouteId` is omitted, the old behavior still applies and a top-level menu plus page will be created automatically. Before initialization, do not call page/tab lifecycle actions such as `addTab`, `updateTab`, `moveTab`, `removeTab`, or `destroyPage`."
     ),
     requestBody: requestBody("FlowSurfaceCreatePageRequest", import_flow_surfaces.flowSurfaceExamples.createPage),
     responses: responses("FlowSurfaceCreatePageResult")
@@ -1642,6 +1642,7 @@ const schemas = {
         }
       },
       example: {},
+      default: {},
       supportsFlowContext: {
         type: "boolean"
       }
@@ -4166,11 +4167,11 @@ const schemas = {
     properties: {
       routeId: {
         ...STRING_OR_INTEGER_SCHEMA,
-        description: "Preferred existing menu-group route id. When present, routeId has the highest priority and title/icon/tooltip/hideInMenu are ignored. applyBlueprint create mode does not mutate existing group metadata; use low-level updateMenu separately when needed."
+        description: "Preferred existing menu-group route id for non-mobile create mode. When present, routeId has the highest priority and title/icon/tooltip/hideInMenu are ignored. Ignored when navigation.layoutUid targets a mobile layout because mobile pages are created as root tabs. applyBlueprint create mode does not mutate existing group metadata; use low-level updateMenu separately when needed."
       },
       title: {
         type: "string",
-        description: "Group title for create mode. When `routeId` is omitted, applyBlueprint reuses a same-title group if the match is unique, creates one when no group exists, and rejects ambiguous multi-match cases. If an existing group is reused, group metadata is ignored; use low-level updateMenu to change existing group metadata."
+        description: "Group title for non-mobile create mode. When `routeId` is omitted, applyBlueprint reuses a same-title group if the match is unique, creates one when no group exists, and rejects ambiguous multi-match cases. Ignored when navigation.layoutUid targets a mobile layout because mobile pages are created as root tabs. If an existing group is reused, group metadata is ignored; use low-level updateMenu to change existing group metadata."
       },
       icon: {
         type: "string",
@@ -4190,6 +4191,10 @@ const schemas = {
   FlowSurfaceApplyBlueprintNavigation: {
     type: "object",
     properties: {
+      layoutUid: {
+        type: "string",
+        description: "Optional enabled UI layout uid that scopes create-mode route lookup and newly created routes. Use `mobile-layout-model` for mobile pages; mobile layouts ignore navigation.group and create a root-level tab page. When omitted, the server preserves the existing parent/default admin layout behavior."
+      },
       group: ref("FlowSurfaceApplyBlueprintNavigationGroup"),
       item: {
         type: "object",
@@ -4405,7 +4410,7 @@ const schemas = {
   FlowSurfaceApplyBlueprintRequest: {
     type: "object",
     required: ["mode", "tabs"],
-    description: `Simplified page-structure request object for applyBlueprint. \`version\` may be omitted and defaults to '1'. Runtime validation enforces mode-specific rules: create does not accept target, while replace requires target.pageSchemaUid and does not use navigation. For JS blocks/fields/actions, \`script\` is a non-empty string asset key into \`assets.scripts\`, and referenced script assets must provide non-empty \`code\`; put inline JS in \`settings.code\` and \`settings.version\`. ${TREE_TABLE_RECORD_ACTION_DEFAULTS_NOTE} ${APPLY_BLUEPRINT_TREE_TABLE_TITLE_FIELD_NOTE} \`defaults.collections\` may provide main data-source collection-level fieldGroups, popup metadata with required \`name\` and \`description\`, and formBehavior for generated default add/edit popup forms; use \`defaults.dataSources.<dataSourceKey>.collections\` for external data sources. v1 does not support \`defaults.blocks\`.`,
+    description: `Simplified page-structure request object for applyBlueprint. \`version\` may be omitted and defaults to '1'. Runtime validation enforces mode-specific rules: create does not accept target, while replace requires target.pageSchemaUid and does not use navigation. In create mode, \`navigation.layoutUid\` scopes menu group reuse, duplicate page identity, and newly created routes to the target layout; use \`mobile-layout-model\` for mobile pages, where \`navigation.group\` is ignored and the page is created as a root tab, and omit it for default admin behavior. For JS blocks/fields/actions, \`script\` is a non-empty string asset key into \`assets.scripts\`, and referenced script assets must provide non-empty \`code\`; put inline JS in \`settings.code\` and \`settings.version\`. ${TREE_TABLE_RECORD_ACTION_DEFAULTS_NOTE} ${APPLY_BLUEPRINT_TREE_TABLE_TITLE_FIELD_NOTE} \`defaults.collections\` may provide main data-source collection-level fieldGroups, popup metadata with required \`name\` and \`description\`, and formBehavior for generated default add/edit popup forms; use \`defaults.dataSources.<dataSourceKey>.collections\` for external data sources. v1 does not support \`defaults.blocks\`.`,
     properties: {
       version: {
         type: "string",
@@ -4577,6 +4582,10 @@ const schemas = {
     type: "object",
     required: ["title"],
     properties: {
+      layoutUid: {
+        type: "string",
+        description: "Optional enabled UI layout uid for the created menu route, for example `mobile-layout-model`. When omitted, the route inherits its parent layout or the default admin layout."
+      },
       title: {
         type: "string"
       },
@@ -4673,6 +4682,10 @@ const schemas = {
   FlowSurfaceCreatePageRequest: {
     type: "object",
     properties: {
+      layoutUid: {
+        type: "string",
+        description: "Optional enabled UI layout uid. With `menuRouteId`, the existing route must already belong to this layout. Without `menuRouteId`, the compatibility create-menu fallback creates the route in this layout."
+      },
       menuRouteId: STRING_OR_INTEGER_SCHEMA,
       pageSchemaUid: {
         type: "string"