@bleedingdev/modern-js-create 3.5.0-ultramodern.3 → 3.5.0-ultramodern.31

package/dist/esm-node/ultramodern-tooling/config/normalize.js

@@ -0,0 +1,107 @@
+import "node:module";
+import node_path from "node:path";
+import { normalizeUltramodernBridgeConfig } from "../../ultramodern-workspace/bridge-config.js";
+import { ULTRAMODERN_CONFIG_PATH, createNeutralOwnership, shellApp } from "../../ultramodern-workspace/descriptors.js";
+import { toKebabCase } from "../../ultramodern-workspace/naming.js";
+import { packageScopeFromRoot } from "./metadata.js";
+function normalizeCompactConfig(workspaceRoot, sourcePath, config) {
+    const packageSource = config.packageSource && 'object' == typeof config.packageSource ? {
+        strategy: 'install' === config.packageSource.strategy ? 'install' : 'workspace',
+        modernPackageVersion: 'string' == typeof config.packageSource.modernPackageVersion ? config.packageSource.modernPackageVersion : 'workspace:*',
+        registry: 'string' == typeof config.packageSource.registry ? config.packageSource.registry : void 0,
+        aliasScope: 'string' == typeof config.packageSource.aliasScope ? config.packageSource.aliasScope : void 0,
+        aliasPackageNamePrefix: 'string' == typeof config.packageSource.aliasPackageNamePrefix ? config.packageSource.aliasPackageNamePrefix : void 0
+    } : void 0;
+    return {
+        schemaVersion: 'number' == typeof config.schemaVersion ? config.schemaVersion : 1,
+        profile: 'string' == typeof config.profile ? config.profile : void 0,
+        source: 'compact',
+        sourcePath,
+        workspace: {
+            packageScope: 'string' == typeof config.workspace?.packageScope ? config.workspace.packageScope : packageScopeFromRoot(workspaceRoot)
+        },
+        packageSource,
+        features: {
+            tailwind: config.features?.tailwind !== false
+        },
+        bridge: normalizeUltramodernBridgeConfig(config.bridge),
+        topology: {
+            apps: Array.isArray(config.topology?.apps) ? config.topology.apps.map((app)=>({
+                    id: String(app.id),
+                    kind: 'vertical' === app.kind ? 'vertical' : 'shell',
+                    path: 'string' == typeof app.path ? app.path : '.',
+                    package: 'string' == typeof app.package ? app.package : void 0,
+                    packageSuffix: 'string' == typeof app.packageSuffix ? app.packageSuffix : void 0,
+                    displayName: 'string' == typeof app.displayName ? app.displayName : void 0,
+                    domain: 'string' == typeof app.domain ? app.domain : void 0,
+                    port: 'number' == typeof app.port ? app.port : void 0,
+                    portEnv: 'string' == typeof app.portEnv ? app.portEnv : void 0,
+                    moduleFederation: app.moduleFederation && 'object' == typeof app.moduleFederation ? {
+                        role: 'remote' === app.moduleFederation.role ? 'remote' : 'host',
+                        name: 'string' == typeof app.moduleFederation.name ? app.moduleFederation.name : void 0,
+                        exposes: Array.isArray(app.moduleFederation.exposes) ? app.moduleFederation.exposes.filter((expose)=>'string' == typeof expose) : void 0,
+                        exposePaths: null === app.moduleFederation.exposePaths || 'object' != typeof app.moduleFederation.exposePaths || Array.isArray(app.moduleFederation.exposePaths) ? void 0 : Object.fromEntries(Object.entries(app.moduleFederation.exposePaths).filter((entry)=>'string' == typeof entry[0] && 'string' == typeof entry[1])),
+                        verticalRefs: Array.isArray(app.moduleFederation.verticalRefs) ? app.moduleFederation.verticalRefs.filter((ref)=>'string' == typeof ref) : void 0,
+                        hostOnly: true === app.moduleFederation.hostOnly,
+                        noExposes: true === app.moduleFederation.noExposes
+                    } : void 0,
+                    api: app.api && 'object' == typeof app.api ? {
+                        stem: 'string' == typeof app.api.stem ? app.api.stem : String(app.id),
+                        prefix: 'string' == typeof app.api.prefix ? app.api.prefix : `/${String(app.id)}-api`,
+                        consumedBy: Array.isArray(app.api.consumedBy) ? app.api.consumedBy.filter((consumer)=>'string' == typeof consumer) : [
+                            shellApp.id,
+                            String(app.id)
+                        ]
+                    } : void 0
+                })) : []
+        }
+    };
+}
+function normalizeCompactUltramodernConfig(workspaceRoot, compact) {
+    return normalizeCompactConfig(workspaceRoot, node_path.join(workspaceRoot, ULTRAMODERN_CONFIG_PATH), compact);
+}
+function workspaceAppsFromToolingConfig(config) {
+    return config.topology.apps.map((app)=>{
+        if ('shell' === app.kind) return {
+            ...shellApp,
+            directory: app.path,
+            packageSuffix: app.packageSuffix ?? shellApp.packageSuffix,
+            displayName: app.displayName ?? shellApp.displayName,
+            port: app.port ?? shellApp.port,
+            portEnv: app.portEnv ?? shellApp.portEnv,
+            mfName: app.moduleFederation?.name ?? shellApp.mfName,
+            verticalRefs: app.moduleFederation?.verticalRefs ?? []
+        };
+        const domain = app.domain ?? app.id;
+        const packageSuffix = app.packageSuffix ?? domain;
+        const exposePaths = app.moduleFederation?.exposePaths ?? {};
+        const exposes = Object.fromEntries((app.moduleFederation?.exposes ?? []).map((expose)=>{
+            const configuredPath = exposePaths[expose];
+            const inferredPath = './Route' === expose ? './src/federation-entry.tsx' : './Widget' === expose ? `./src/components/${domain}-widget.tsx` : `./src/components/${toKebabCase(expose.replace(/^\.\//u, ''))}.tsx`;
+            return [
+                expose,
+                configuredPath ?? inferredPath
+            ];
+        }));
+        return {
+            id: app.id,
+            directory: app.path,
+            packageSuffix,
+            displayName: app.displayName ?? `${domain} Vertical`,
+            kind: 'vertical',
+            domain,
+            portEnv: app.portEnv ?? `VERTICAL_${domain.replace(/[^a-zA-Z0-9]+/g, '_').toUpperCase()}_PORT`,
+            port: app.port ?? 0,
+            mfName: app.moduleFederation?.name ?? app.id,
+            exposes,
+            ...app.moduleFederation?.verticalRefs ? {
+                verticalRefs: app.moduleFederation.verticalRefs
+            } : {},
+            ...app.api ? {
+                api: app.api
+            } : {},
+            ownership: createNeutralOwnership(app.id)
+        };
+    });
+}
+export { normalizeCompactConfig, normalizeCompactUltramodernConfig, workspaceAppsFromToolingConfig };

package/dist/esm-node/ultramodern-tooling/config/synthesize.js

@@ -0,0 +1,109 @@
+import "node:module";
+import node_fs from "node:fs";
+import node_path from "node:path";
+import { shellApp } from "../../ultramodern-workspace/descriptors.js";
+import { toKebabCase } from "../../ultramodern-workspace/naming.js";
+import { LEGACY_DEVELOPMENT_OVERLAY_PATH, LEGACY_GENERATED_CONTRACT_PATH, LEGACY_PACKAGE_SOURCE_METADATA_PATH } from "./constants.js";
+import { readJsonObject } from "./json.js";
+import { packageScopeFromRoot, packageSourceFromMetadata, readOverlayPorts } from "./metadata.js";
+function synthesizeCompactUltramodernConfig(workspaceRoot) {
+    const contractPath = node_path.join(workspaceRoot, LEGACY_GENERATED_CONTRACT_PATH);
+    if (!node_fs.existsSync(contractPath)) return;
+    const contract = readJsonObject(contractPath);
+    const sources = [
+        LEGACY_GENERATED_CONTRACT_PATH
+    ];
+    const missing = [];
+    const packageSource = packageSourceFromMetadata(workspaceRoot);
+    if (packageSource) sources.push(LEGACY_PACKAGE_SOURCE_METADATA_PATH);
+    else missing.push(LEGACY_PACKAGE_SOURCE_METADATA_PATH);
+    const ports = readOverlayPorts(workspaceRoot);
+    if (node_fs.existsSync(node_path.join(workspaceRoot, LEGACY_DEVELOPMENT_OVERLAY_PATH))) sources.push(LEGACY_DEVELOPMENT_OVERLAY_PATH);
+    else missing.push(LEGACY_DEVELOPMENT_OVERLAY_PATH);
+    const apps = Array.isArray(contract.apps) ? contract.apps : [];
+    const shell = apps.find((app)=>app?.id === shellApp.id);
+    const compact = {
+        schemaVersion: 'number' == typeof contract.schemaVersion ? contract.schemaVersion : 1,
+        ...'string' == typeof contract.profile ? {
+            profile: contract.profile
+        } : {},
+        workspace: {
+            packageScope: packageScopeFromRoot(workspaceRoot)
+        },
+        ...packageSource ? {
+            packageSource: {
+                strategy: packageSource.strategy,
+                modernPackageVersion: packageSource.modernPackageVersion,
+                ...packageSource.registry ? {
+                    registry: packageSource.registry
+                } : {},
+                ...packageSource.aliasScope ? {
+                    aliasScope: packageSource.aliasScope
+                } : {},
+                ...packageSource.aliasPackageNamePrefix ? {
+                    aliasPackageNamePrefix: packageSource.aliasPackageNamePrefix
+                } : {}
+            }
+        } : {},
+        features: {
+            tailwind: shell?.styling?.tailwind !== false
+        },
+        topology: {
+            apps: apps.map((app)=>{
+                const id = String(app.id);
+                const appPath = 'string' == typeof app.path ? app.path : id === shellApp.id ? shellApp.directory : `verticals/${toKebabCase(id)}`;
+                const domain = 'string' == typeof app.i18n?.namespace && 'shell' !== app.i18n.namespace ? app.i18n.namespace : appPath.split('/').at(-1);
+                const moduleFederation = app.moduleFederation && 'object' == typeof app.moduleFederation ? {
+                    role: 'vertical' === app.kind ? 'remote' : 'host',
+                    ...'string' == typeof app.moduleFederation.name ? {
+                        name: app.moduleFederation.name
+                    } : {},
+                    ...Array.isArray(app.moduleFederation.exposes) ? {
+                        exposes: app.moduleFederation.exposes.filter((expose)=>'string' == typeof expose)
+                    } : {},
+                    ...Array.isArray(app.moduleFederation.verticalRefs) ? {
+                        verticalRefs: app.moduleFederation.verticalRefs.filter((ref)=>'string' == typeof ref)
+                    } : {}
+                } : void 0;
+                const api = app.effect && 'object' == typeof app.effect ? {
+                    stem: 'string' == typeof app.effect.prefix ? app.effect.prefix.split('/').filter(Boolean).at(-1) ?? domain ?? id : domain ?? id,
+                    prefix: 'string' == typeof app.effect.prefix ? app.effect.prefix : `/${domain ?? id}-api`,
+                    consumedBy: [
+                        shellApp.id,
+                        id
+                    ]
+                } : void 0;
+                return {
+                    id,
+                    kind: 'vertical' === app.kind ? 'vertical' : 'shell',
+                    path: appPath,
+                    ...'string' == typeof app.package ? {
+                        package: app.package
+                    } : {},
+                    packageSuffix: 'string' == typeof app.package ? app.package.split('/').at(-1) : appPath.split('/').at(-1),
+                    ...id === shellApp.id ? {
+                        displayName: shellApp.displayName
+                    } : {},
+                    ...domain ? {
+                        domain
+                    } : {},
+                    ...'number' == typeof ports[id] ? {
+                        port: ports[id]
+                    } : {},
+                    ...moduleFederation ? {
+                        moduleFederation
+                    } : {},
+                    ...api ? {
+                        api
+                    } : {}
+                };
+            })
+        }
+    };
+    return {
+        compact,
+        missing,
+        sources
+    };
+}
+export { synthesizeCompactUltramodernConfig };

package/dist/esm-node/ultramodern-tooling/config/types.js

@@ -0,0 +1 @@
+import "node:module";

package/dist/esm-node/ultramodern-tooling/config.js

@@ -1,121 +1,2 @@
 import "node:module";
-import node_fs from "node:fs";
-import node_path from "node:path";
-import { normalizeUltramodernBridgeConfig } from "../ultramodern-workspace/bridge-config.js";
-import { ULTRAMODERN_CONFIG_PATH, createNeutralOwnership, shellApp } from "../ultramodern-workspace/descriptors.js";
-import { toKebabCase } from "../ultramodern-workspace/naming.js";
-function readJsonObject(filePath) {
-    const value = JSON.parse(node_fs.readFileSync(filePath, 'utf-8'));
-    if (null === value || 'object' != typeof value || Array.isArray(value)) throw new Error(`UltraModern config must contain a JSON object: ${filePath}`);
-    return value;
-}
-function readOptionalJsonObject(filePath) {
-    return node_fs.existsSync(filePath) ? readJsonObject(filePath) : {};
-}
-function packageScopeFromRoot(workspaceRoot1) {
-    const rootPackage = readOptionalJsonObject(node_path.join(workspaceRoot1, 'package.json'));
-    return 'string' == typeof rootPackage.name && rootPackage.name.length > 0 ? rootPackage.name : node_path.basename(workspaceRoot1);
-}
-function normalizeCompactConfig(sourcePath, config) {
-    const packageSource = config.packageSource && 'object' == typeof config.packageSource ? {
-        strategy: 'install' === config.packageSource.strategy ? 'install' : 'workspace',
-        modernPackageVersion: 'string' == typeof config.packageSource.modernPackageVersion ? config.packageSource.modernPackageVersion : 'workspace:*',
-        registry: 'string' == typeof config.packageSource.registry ? config.packageSource.registry : void 0,
-        aliasScope: 'string' == typeof config.packageSource.aliasScope ? config.packageSource.aliasScope : void 0,
-        aliasPackageNamePrefix: 'string' == typeof config.packageSource.aliasPackageNamePrefix ? config.packageSource.aliasPackageNamePrefix : void 0
-    } : void 0;
-    return {
-        schemaVersion: 'number' == typeof config.schemaVersion ? config.schemaVersion : 1,
-        profile: 'string' == typeof config.profile ? config.profile : void 0,
-        source: 'compact',
-        sourcePath,
-        workspace: {
-            packageScope: 'string' == typeof config.workspace?.packageScope ? config.workspace.packageScope : packageScopeFromRoot(workspaceRoot)
-        },
-        packageSource,
-        features: {
-            tailwind: config.features?.tailwind !== false
-        },
-        bridge: normalizeUltramodernBridgeConfig(config.bridge),
-        topology: {
-            apps: Array.isArray(config.topology?.apps) ? config.topology.apps.map((app)=>({
-                    id: String(app.id),
-                    kind: 'vertical' === app.kind ? 'vertical' : 'shell',
-                    path: 'string' == typeof app.path ? app.path : '.',
-                    package: 'string' == typeof app.package ? app.package : void 0,
-                    packageSuffix: 'string' == typeof app.packageSuffix ? app.packageSuffix : void 0,
-                    displayName: 'string' == typeof app.displayName ? app.displayName : void 0,
-                    domain: 'string' == typeof app.domain ? app.domain : void 0,
-                    port: 'number' == typeof app.port ? app.port : void 0,
-                    portEnv: 'string' == typeof app.portEnv ? app.portEnv : void 0,
-                    moduleFederation: app.moduleFederation && 'object' == typeof app.moduleFederation ? {
-                        role: 'remote' === app.moduleFederation.role ? 'remote' : 'host',
-                        name: 'string' == typeof app.moduleFederation.name ? app.moduleFederation.name : void 0,
-                        exposes: Array.isArray(app.moduleFederation.exposes) ? app.moduleFederation.exposes.filter((expose)=>'string' == typeof expose) : void 0,
-                        exposePaths: null === app.moduleFederation.exposePaths || 'object' != typeof app.moduleFederation.exposePaths || Array.isArray(app.moduleFederation.exposePaths) ? void 0 : Object.fromEntries(Object.entries(app.moduleFederation.exposePaths).filter((entry)=>'string' == typeof entry[0] && 'string' == typeof entry[1])),
-                        verticalRefs: Array.isArray(app.moduleFederation.verticalRefs) ? app.moduleFederation.verticalRefs.filter((ref)=>'string' == typeof ref) : void 0,
-                        hostOnly: true === app.moduleFederation.hostOnly,
-                        noExposes: true === app.moduleFederation.noExposes
-                    } : void 0,
-                    api: app.api && 'object' == typeof app.api ? {
-                        stem: 'string' == typeof app.api.stem ? app.api.stem : String(app.id),
-                        prefix: 'string' == typeof app.api.prefix ? app.api.prefix : `/${String(app.id)}-api`,
-                        consumedBy: Array.isArray(app.api.consumedBy) ? app.api.consumedBy.filter((consumer)=>'string' == typeof consumer) : [
-                            shellApp.id,
-                            String(app.id)
-                        ]
-                    } : void 0
-                })) : []
-        }
-    };
-}
-function readUltramodernConfig(workspaceRoot1 = process.cwd()) {
-    const compactPath = node_path.join(workspaceRoot1, ULTRAMODERN_CONFIG_PATH);
-    if (node_fs.existsSync(compactPath)) return normalizeCompactConfig(compactPath, readJsonObject(compactPath));
-    throw new Error(`Missing UltraModern config. Expected ${ULTRAMODERN_CONFIG_PATH}.`);
-}
-function workspaceAppsFromToolingConfig(config) {
-    return config.topology.apps.map((app)=>{
-        if ('shell' === app.kind) return {
-            ...shellApp,
-            directory: app.path,
-            packageSuffix: app.packageSuffix ?? shellApp.packageSuffix,
-            displayName: app.displayName ?? shellApp.displayName,
-            port: app.port ?? shellApp.port,
-            portEnv: app.portEnv ?? shellApp.portEnv,
-            mfName: app.moduleFederation?.name ?? shellApp.mfName,
-            verticalRefs: app.moduleFederation?.verticalRefs ?? []
-        };
-        const domain = app.domain ?? app.id;
-        const packageSuffix = app.packageSuffix ?? domain;
-        const exposePaths = app.moduleFederation?.exposePaths ?? {};
-        const exposes = Object.fromEntries((app.moduleFederation?.exposes ?? []).map((expose)=>{
-            const configuredPath = exposePaths[expose];
-            const inferredPath = './Route' === expose ? './src/federation-entry.tsx' : './Widget' === expose ? `./src/components/${domain}-widget.tsx` : `./src/components/${toKebabCase(expose.replace(/^\.\//u, ''))}.tsx`;
-            return [
-                expose,
-                configuredPath ?? inferredPath
-            ];
-        }));
-        return {
-            id: app.id,
-            directory: app.path,
-            packageSuffix,
-            displayName: app.displayName ?? `${domain} Vertical`,
-            kind: 'vertical',
-            domain,
-            portEnv: app.portEnv ?? `VERTICAL_${domain.replace(/[^a-zA-Z0-9]+/g, '_').toUpperCase()}_PORT`,
-            port: app.port ?? 0,
-            mfName: app.moduleFederation?.name ?? app.id,
-            exposes,
-            ...app.moduleFederation?.verticalRefs ? {
-                verticalRefs: app.moduleFederation.verticalRefs
-            } : {},
-            ...app.api ? {
-                api: app.api
-            } : {},
-            ownership: createNeutralOwnership(app.id)
-        };
-    });
-}
-export { readUltramodernConfig, workspaceAppsFromToolingConfig };
+export * from "./config/index.js";

package/dist/esm-node/ultramodern-workspace/add-vertical/constants.js

@@ -0,0 +1,6 @@
+import "node:module";
+const FIRST_VERTICAL_PORT = 4101;
+const TOPOLOGY_PATH = 'topology/reference-topology.json';
+const OWNERSHIP_PATH = 'topology/ownership.json';
+const DEVELOPMENT_OVERLAY_PATH = 'topology/local-overlays/development.json';
+export { DEVELOPMENT_OVERLAY_PATH, FIRST_VERTICAL_PORT, OWNERSHIP_PATH, TOPOLOGY_PATH };

package/dist/esm-node/ultramodern-workspace/add-vertical/execute.js

@@ -0,0 +1,109 @@
+import "node:module";
+import node_path from "node:path";
+import { createServerExecutionOverlay } from "../backend-federation.js";
+import { ULTRAMODERN_CONFIG_PATH, resolveApiPrefix, shellApp } from "../descriptors.js";
+import { formatGeneratedWorkspaceFiles, writeFileReplacing, writeJsonFile } from "../fs-io.js";
+import { createFileSnapshot, createGenerationResult, diffFileSnapshots } from "../generation-result.js";
+import { runCodeSmithOverlays } from "../overlays.js";
+import { createRootTsConfig } from "../package-json.js";
+import { writeGeneratedWorkspaceScripts } from "../workspace-scripts.js";
+import { createCompactUltramodernConfig, writeApp } from "../write-workspace.js";
+import { createZeropsYaml } from "../zerops.js";
+import { prepareAddUltramodernVertical } from "./preflight.js";
+import { addShellWorkspaceDependency, addShellZephyrDependency, rewriteShellAppFiles, updateRootWorkspaceScripts } from "./shell-files.js";
+import { ownershipEntry, verticalTopologyEntry } from "./topology.js";
+function addUltramodernVertical(options) {
+    const beforeFiles = createFileSnapshot(options.workspaceRoot);
+    const { scope, topologyPath, ownershipPath, overlayPath, topology, ownership, overlay, packageSource, enableTailwind, bridge, vertical, updatedVerticals } = prepareAddUltramodernVertical(options);
+    writeApp(options.workspaceRoot, scope, vertical, packageSource, enableTailwind, updatedVerticals, bridge);
+    topology.shell ??= {};
+    topology.shell.verticalRefs ??= [];
+    topology.shell.verticalRefs = topology.shell.verticalRefs.filter((id)=>id !== vertical.id);
+    topology.shell.verticalRefs.push(vertical.id);
+    topology.shell.moduleFederation ??= {};
+    topology.shell.moduleFederation.remotes ??= [];
+    topology.shell.moduleFederation.remotes = topology.shell.moduleFederation.remotes.filter((remote)=>remote?.id !== vertical.id);
+    topology.shell.moduleFederation.remotes.push({
+        id: vertical.id,
+        name: vertical.mfName,
+        manifestUrl: `http://localhost:${vertical.port}/mf-manifest.json`
+    });
+    topology.verticals ??= [];
+    topology.verticals.push(verticalTopologyEntry(scope, vertical));
+    ownership.owners ??= [];
+    ownership.owners.push(ownershipEntry(scope, vertical));
+    overlay.ports[vertical.id] = vertical.port;
+    overlay.manifests ??= {};
+    overlay.manifests[vertical.id] = `http://localhost:${vertical.port}/mf-manifest.json`;
+    overlay.serverExecution ??= {};
+    overlay.serverExecution[vertical.id] = createServerExecutionOverlay(scope, vertical);
+    overlay.apis ??= {};
+    overlay.apis[vertical.id] = `http://localhost:${vertical.port}${resolveApiPrefix(vertical)}`;
+    writeJsonFile(topologyPath, topology);
+    writeJsonFile(ownershipPath, ownership);
+    writeJsonFile(overlayPath, overlay);
+    writeJsonFile(node_path.join(options.workspaceRoot, ULTRAMODERN_CONFIG_PATH), createCompactUltramodernConfig(scope, options.modernVersion, packageSource, [
+        {
+            ...shellApp,
+            verticalRefs: updatedVerticals.map((vertical)=>vertical.id)
+        },
+        ...updatedVerticals
+    ], enableTailwind, bridge));
+    writeFileReplacing(options.workspaceRoot, 'zerops.yaml', `${createZeropsYaml(scope, [
+        {
+            ...shellApp,
+            verticalRefs: updatedVerticals.map((vertical)=>vertical.id)
+        },
+        ...updatedVerticals
+    ])}\n`);
+    rewriteShellAppFiles(options.workspaceRoot, scope, packageSource, enableTailwind, updatedVerticals, bridge);
+    writeGeneratedWorkspaceScripts(options.workspaceRoot, scope, enableTailwind, updatedVerticals);
+    addShellZephyrDependency(options.workspaceRoot, scope, vertical);
+    addShellWorkspaceDependency(options.workspaceRoot, scope, vertical);
+    updateRootWorkspaceScripts(options.workspaceRoot, scope, packageSource, updatedVerticals, bridge);
+    writeJsonFile(node_path.join(options.workspaceRoot, 'tsconfig.json'), createRootTsConfig([
+        {
+            ...shellApp,
+            verticalRefs: updatedVerticals.map((vertical)=>vertical.id)
+        },
+        ...updatedVerticals
+    ]));
+    const preliminaryAfterFiles = createFileSnapshot(options.workspaceRoot);
+    const preliminaryDiff = diffFileSnapshots(beforeFiles, preliminaryAfterFiles);
+    const preliminaryResult = createGenerationResult({
+        operation: 'vertical',
+        workspaceRoot: options.workspaceRoot,
+        packageScope: scope,
+        packageSource,
+        createdApps: [
+            vertical
+        ],
+        createdPaths: preliminaryDiff.createdPaths,
+        rewrittenPaths: preliminaryDiff.rewrittenPaths
+    });
+    runCodeSmithOverlays({
+        workspaceRoot: options.workspaceRoot,
+        overlays: options.overlays,
+        result: preliminaryResult
+    });
+    const afterOverlaysFiles = createFileSnapshot(options.workspaceRoot);
+    const changedPaths = diffFileSnapshots(beforeFiles, afterOverlaysFiles);
+    formatGeneratedWorkspaceFiles(options.workspaceRoot, [
+        ...changedPaths.createdPaths,
+        ...changedPaths.rewrittenPaths
+    ]);
+    const afterFiles = createFileSnapshot(options.workspaceRoot);
+    const { createdPaths, rewrittenPaths } = diffFileSnapshots(beforeFiles, afterFiles);
+    return createGenerationResult({
+        operation: 'vertical',
+        workspaceRoot: options.workspaceRoot,
+        packageScope: scope,
+        packageSource,
+        createdApps: [
+            vertical
+        ],
+        createdPaths,
+        rewrittenPaths
+    });
+}
+export { addUltramodernVertical };

package/dist/esm-node/ultramodern-workspace/add-vertical/plan.js

@@ -0,0 +1,185 @@
+import "node:module";
+import node_fs from "node:fs";
+import node_os from "node:os";
+import node_path from "node:path";
+import { WORKSPACE_PACKAGE_VERSION } from "../../ultramodern-package-source.js";
+import { createServerExecutionOverlay } from "../backend-federation.js";
+import { ULTRAMODERN_CONFIG_PATH, appHasApi, remoteDependencyAlias, resolveApiPrefix, shellApp, zephyrRemoteDependency } from "../descriptors.js";
+import { packageName } from "../naming.js";
+import { DEVELOPMENT_OVERLAY_PATH, OWNERSHIP_PATH, TOPOLOGY_PATH } from "./constants.js";
+import { addUltramodernVertical } from "./execute.js";
+import { prepareAddUltramodernVertical } from "./preflight.js";
+import { ownershipEntry, verticalTopologyEntry } from "./topology.js";
+function planUltramodernVertical(options) {
+    const preflight = prepareAddUltramodernVertical(options);
+    const tempRoot = node_fs.mkdtempSync(node_path.join(node_os.tmpdir(), 'um-vertical-plan-'));
+    const copiedWorkspaceRoot = node_path.join(tempRoot, 'workspace');
+    try {
+        copyWorkspaceForPlan(options.workspaceRoot, copiedWorkspaceRoot);
+        const plannedResult = addUltramodernVertical({
+            ...options,
+            workspaceRoot: copiedWorkspaceRoot,
+            overlays: void 0
+        });
+        return createVerticalPlan(preflight, {
+            ...plannedResult,
+            workspaceRoot: options.workspaceRoot
+        });
+    } finally{
+        node_fs.rmSync(tempRoot, {
+            recursive: true,
+            force: true
+        });
+    }
+}
+function copyWorkspaceForPlan(workspaceRoot, copiedWorkspaceRoot) {
+    const skippedDirectories = new Set([
+        '.git',
+        '.nx',
+        '.output',
+        'coverage',
+        'dist',
+        'node_modules'
+    ]);
+    node_fs.cpSync(workspaceRoot, copiedWorkspaceRoot, {
+        recursive: true,
+        filter: (sourcePath)=>!skippedDirectories.has(node_path.basename(sourcePath))
+    });
+}
+function createVerticalPlan(preflight, result) {
+    const { scope, vertical, updatedVerticals } = preflight;
+    const manifestUrl = `http://localhost:${vertical.port}/mf-manifest.json`;
+    return {
+        ...result,
+        dryRun: true,
+        selectedPort: vertical.port,
+        moduleFederationRemote: {
+            id: vertical.id,
+            name: vertical.mfName,
+            manifestUrl
+        },
+        ...vertical.api ? {
+            apiPrefix: resolveApiPrefix(vertical)
+        } : {},
+        jsonMutations: createDryRunJsonMutations(preflight, manifestUrl),
+        shellDependencyChanges: createShellDependencyChanges(scope, vertical),
+        generatedContractChanges: [
+            {
+                path: ULTRAMODERN_CONFIG_PATH,
+                addedAppIds: [
+                    vertical.id
+                ],
+                shellVerticalRefs: updatedVerticals.map((vertical)=>vertical.id)
+            }
+        ]
+    };
+}
+function createDryRunJsonMutations(preflight, manifestUrl) {
+    const { scope, vertical } = preflight;
+    const apiMutation = appHasApi(vertical) ? [
+        {
+            path: DEVELOPMENT_OVERLAY_PATH,
+            pointer: `/apis/${vertical.id}`,
+            description: `Add local API URL for ${vertical.id}`,
+            value: `http://localhost:${vertical.port}${resolveApiPrefix(vertical)}`
+        },
+        {
+            path: DEVELOPMENT_OVERLAY_PATH,
+            pointer: `/serverExecution/${vertical.id}`,
+            description: `Add local MicroVertical server execution metadata for ${vertical.id}`,
+            value: createServerExecutionOverlay(scope, vertical)
+        }
+    ] : [];
+    return [
+        {
+            path: TOPOLOGY_PATH,
+            pointer: '/shell/verticalRefs/-',
+            description: `Add ${vertical.id} to the shell vertical references`,
+            value: vertical.id
+        },
+        {
+            path: TOPOLOGY_PATH,
+            pointer: '/shell/moduleFederation/remotes/-',
+            description: `Register ${vertical.id} as a Module Federation remote`,
+            value: {
+                id: vertical.id,
+                name: vertical.mfName,
+                manifestUrl
+            }
+        },
+        {
+            path: TOPOLOGY_PATH,
+            pointer: '/verticals/-',
+            description: `Add topology entry for ${vertical.id}`,
+            value: verticalTopologyEntry(scope, vertical)
+        },
+        {
+            path: OWNERSHIP_PATH,
+            pointer: '/owners/-',
+            description: `Add ownership entry for ${vertical.id}`,
+            value: ownershipEntry(scope, vertical)
+        },
+        {
+            path: DEVELOPMENT_OVERLAY_PATH,
+            pointer: `/ports/${vertical.id}`,
+            description: `Reserve development port ${vertical.port}`,
+            value: vertical.port
+        },
+        {
+            path: DEVELOPMENT_OVERLAY_PATH,
+            pointer: `/manifests/${vertical.id}`,
+            description: `Add local Module Federation manifest URL for ${vertical.id}`,
+            value: manifestUrl
+        },
+        ...apiMutation,
+        {
+            path: 'package.json',
+            pointer: "/scripts",
+            description: "Regenerate workspace scripts for the new vertical set"
+        },
+        {
+            path: `${shellApp.directory}/package.json`,
+            pointer: '/dependencies',
+            description: `Wire shell dependencies for ${vertical.id}`
+        },
+        {
+            path: 'tsconfig.json',
+            pointer: '/references',
+            description: `Add ${vertical.id} to the root TS-Go build graph`
+        },
+        {
+            path: `${shellApp.directory}/tsconfig.json`,
+            pointer: '/references',
+            description: `Add ${vertical.id} to the shell TS-Go project references`
+        },
+        {
+            path: `${shellApp.directory}/tsconfig.mf-types.json`,
+            pointer: '/include',
+            description: 'Keep shell Module Federation DTS compilation scoped'
+        },
+        {
+            path: ULTRAMODERN_CONFIG_PATH,
+            pointer: '/topology/apps',
+            description: `Regenerate compact config with ${vertical.id}`
+        }
+    ];
+}
+function createShellDependencyChanges(scope, vertical) {
+    return [
+        {
+            path: `${shellApp.directory}/package.json`,
+            section: 'zephyr:dependencies',
+            packageName: remoteDependencyAlias(vertical),
+            version: zephyrRemoteDependency(scope, vertical)
+        },
+        ...appHasApi(vertical) ? [
+            {
+                path: `${shellApp.directory}/package.json`,
+                section: 'dependencies',
+                packageName: packageName(scope, vertical.packageSuffix),
+                version: WORKSPACE_PACKAGE_VERSION
+            }
+        ] : []
+    ];
+}
+export { copyWorkspaceForPlan, createDryRunJsonMutations, createShellDependencyChanges, createVerticalPlan, planUltramodernVertical };