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

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

@@ -0,0 +1,123 @@
+import "node:module";
+import node_fs from "node:fs";
+import node_path from "node:path";
+import { ULTRAMODERN_CONFIG_PATH, createRemoteManifestEnv, createVerticalDescriptor, shellApp } from "../descriptors.js";
+import { readJsonFile } from "../fs-io.js";
+import { assertUniqueTailwindPrefixes, normalizePath, toPackageScope } from "../naming.js";
+import { isRecord } from "../types.js";
+import { DEVELOPMENT_OVERLAY_PATH, OWNERSHIP_PATH, TOPOLOGY_PATH } from "./constants.js";
+import { verticalsFromTopology } from "./topology.js";
+import { assertCanCreate, assertValidVerticalName, existingBridgeConfig, existingPackageSource, existingTailwindEnabled, nextAvailablePort } from "./workspace-state.js";
+function prepareAddUltramodernVertical(options) {
+    const name = assertValidVerticalName(options.name);
+    const topologyPath = node_path.join(options.workspaceRoot, TOPOLOGY_PATH);
+    const ownershipPath = node_path.join(options.workspaceRoot, OWNERSHIP_PATH);
+    const overlayPath = node_path.join(options.workspaceRoot, DEVELOPMENT_OVERLAY_PATH);
+    const rootPackage = readRequiredJsonObject(node_path.join(options.workspaceRoot, 'package.json'));
+    const topology = readRequiredJsonObject(topologyPath);
+    const ownership = readRequiredJsonObject(ownershipPath);
+    const overlay = readRequiredJsonObject(overlayPath);
+    readRequiredWorkspaceConfig(options.workspaceRoot);
+    assertOptionalJsonObject(topology.shell, 'topology.shell', topologyPath);
+    assertOptionalJsonArray(topology.verticals, 'topology.verticals', topologyPath);
+    assertOptionalJsonArray(ownership.owners, 'ownership.owners', ownershipPath);
+    assertOptionalJsonObject(overlay.ports, 'overlay.ports', overlayPath);
+    assertOptionalJsonObject(overlay.manifests, 'overlay.manifests', overlayPath);
+    assertOptionalJsonObject(overlay.apis, 'overlay.apis', overlayPath);
+    overlay.ports ??= {};
+    const scope = toPackageScope(String(rootPackage.name ?? node_path.basename(options.workspaceRoot)));
+    const packageSource = existingPackageSource(options.workspaceRoot, options.modernVersion, options.packageSource);
+    const enableTailwind = options.enableTailwind ?? existingTailwindEnabled(options.workspaceRoot);
+    const bridge = existingBridgeConfig(options.workspaceRoot);
+    const existingVerticals = verticalsFromTopology(topology, overlay.ports);
+    const port = nextAvailablePort(overlay.ports);
+    const vertical = createVerticalDescriptor(name, port);
+    const updatedVerticals = [
+        ...existingVerticals,
+        vertical
+    ];
+    const allApps = [
+        shellApp,
+        ...updatedVerticals
+    ];
+    assertCanCreate(options.workspaceRoot, vertical.directory);
+    validateWorkspaceAppDescriptors(allApps);
+    validateUniqueWorkspaceAppDescriptors(allApps);
+    assertUniqueTailwindPrefixes(allApps);
+    return {
+        name,
+        scope,
+        topologyPath,
+        ownershipPath,
+        overlayPath,
+        rootPackage,
+        topology,
+        ownership,
+        overlay,
+        packageSource,
+        enableTailwind,
+        bridge,
+        vertical,
+        updatedVerticals
+    };
+}
+function readRequiredJsonObject(filePath) {
+    if (!node_fs.existsSync(filePath)) throw new Error(`Missing UltraModern workspace file: ${filePath}`);
+    const value = readJsonFile(filePath);
+    if (!isRecord(value)) throw new Error(`UltraModern workspace file must contain a JSON object: ${filePath}`);
+    return value;
+}
+function readRequiredWorkspaceConfig(workspaceRoot) {
+    const compactPath = node_path.join(workspaceRoot, ULTRAMODERN_CONFIG_PATH);
+    readRequiredJsonObject(compactPath);
+}
+function assertOptionalJsonObject(value, label, filePath) {
+    if (void 0 !== value && !isRecord(value)) throw new Error(`${label} in ${filePath} must be a JSON object`);
+}
+function assertOptionalJsonArray(value, label, filePath) {
+    if (void 0 !== value && !Array.isArray(value)) throw new Error(`${label} in ${filePath} must be a JSON array`);
+}
+function validateWorkspaceAppDescriptors(apps) {
+    for (const app of apps){
+        const appLabel = 'string' == typeof app.id && app.id ? app.id : '<unknown>';
+        assertNonEmptyString(app.id, `app id for ${appLabel}`);
+        assertNonEmptyString(app.directory, `directory for ${appLabel}`);
+        assertSafeOutputPath(app.directory, appLabel);
+        assertNonEmptyString(app.packageSuffix, `package suffix for ${appLabel}`);
+        assertNonEmptyString(app.displayName, `display name for ${appLabel}`);
+        if ('shell' !== app.kind && 'vertical' !== app.kind) throw new Error(`Invalid app kind for ${appLabel}: ${String(app.kind)}`);
+        assertNonEmptyString(app.portEnv, `port env for ${appLabel}`);
+        if ('number' != typeof app.port || !Number.isFinite(app.port) || app.port <= 0) throw new Error(`Invalid development port for ${appLabel}`);
+        assertNonEmptyString(app.mfName, `Module Federation name for ${appLabel}`);
+        if (app.api) {
+            assertNonEmptyString(app.api.prefix, `API prefix for ${appLabel}`);
+            if (!app.api.prefix.startsWith('/')) throw new Error(`API prefix for ${appLabel} must start with "/"`);
+        }
+    }
+}
+function validateUniqueWorkspaceAppDescriptors(apps) {
+    assertUniqueAppField(apps, 'app id', (app)=>app.id);
+    assertUniqueAppField(apps, 'package suffix', (app)=>app.packageSuffix);
+    assertUniqueAppField(apps, 'output path', (app)=>normalizePath(app.directory));
+    assertUniqueAppField(apps, 'Module Federation name', (app)=>app.mfName);
+    assertUniqueAppField(apps, 'development port', (app)=>String(app.port));
+    assertUniqueAppField(apps, 'API prefix', (app)=>app.api?.prefix);
+    assertUniqueAppField(apps, 'manifest environment name', (app)=>'vertical' === app.kind ? createRemoteManifestEnv(app) : void 0);
+}
+function assertUniqueAppField(apps, label, readValue) {
+    const seen = new Map();
+    for (const app of apps){
+        const value = readValue(app);
+        if (!value) continue;
+        const previousId = seen.get(value);
+        if (previousId) throw new Error(`Duplicate ${label} "${value}" for ${previousId} and ${app.id}`);
+        seen.set(value, app.id);
+    }
+}
+function assertNonEmptyString(value, label) {
+    if ('string' != typeof value || 0 === value.length) throw new Error(`Invalid ${label}`);
+}
+function assertSafeOutputPath(relativePath, appId) {
+    if (node_path.isAbsolute(relativePath) || relativePath.split(/[\\/]+/u).includes('..')) throw new Error(`Unsafe output path for ${appId}: ${relativePath}`);
+}
+export { assertNonEmptyString, assertOptionalJsonArray, assertOptionalJsonObject, assertSafeOutputPath, assertUniqueAppField, prepareAddUltramodernVertical, readRequiredJsonObject, readRequiredWorkspaceConfig, validateUniqueWorkspaceAppDescriptors, validateWorkspaceAppDescriptors };

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

@@ -0,0 +1,60 @@
+import "node:module";
+import node_path from "node:path";
+import { WORKSPACE_PACKAGE_VERSION } from "../../ultramodern-package-source.js";
+import { createShellApiClient } from "../api.js";
+import { createAppEnvDts, createAppRuntimeConfig, createShellFrameComponent } from "../app-files.js";
+import { createShellPage, createShellRemoteComponents } from "../demo-components.js";
+import { appHasApi, appI18nNamespace, createShellHost, remoteDependencyAlias, shellApp, zephyrRemoteDependency } from "../descriptors.js";
+import { readJsonFile, writeFileReplacing, writeJsonFile } from "../fs-io.js";
+import { createAppPublicLocaleMessages } from "../locales.js";
+import { createAppModernConfig, createShellModuleFederationConfig } from "../module-federation.js";
+import { packageName } from "../naming.js";
+import { createAppMfTypesTsConfig, createAppPackage, createAppTsConfig, createRootPackageJson } from "../package-json.js";
+import { createPublicWebAppArtifacts, rewriteWorkspaceAssetsForApp } from "../public-surface.js";
+function updateRootWorkspaceScripts(workspaceRoot, scope, packageSource, remotes, bridge) {
+    const packagePath = node_path.join(workspaceRoot, 'package.json');
+    const rootPackage = readJsonFile(packagePath);
+    const generatedRootPackage = createRootPackageJson(scope, packageSource, remotes, bridge);
+    rootPackage.scripts = generatedRootPackage.scripts;
+    writeJsonFile(packagePath, rootPackage);
+}
+function rewriteShellAppFiles(workspaceRoot, scope, packageSource, enableTailwind, remotes, bridge) {
+    const shellHost = createShellHost(remotes);
+    const publicWeb = createPublicWebAppArtifacts(shellHost);
+    writeJsonFile(node_path.join(workspaceRoot, `${shellApp.directory}/package.json`), createAppPackage(scope, shellHost, packageSource, enableTailwind, remotes, bridge));
+    writeJsonFile(node_path.join(workspaceRoot, `${shellApp.directory}/tsconfig.json`), createAppTsConfig(shellHost, remotes));
+    writeJsonFile(node_path.join(workspaceRoot, `${shellApp.directory}/tsconfig.mf-types.json`), createAppMfTypesTsConfig(shellHost));
+    writeFileReplacing(workspaceRoot, `${shellApp.directory}/src/modern-app-env.d.ts`, createAppEnvDts(shellHost, remotes));
+    writeFileReplacing(workspaceRoot, `${shellApp.directory}/modern.config.ts`, createAppModernConfig(scope, shellHost, remotes));
+    writeFileReplacing(workspaceRoot, publicWeb.jsonLdHelperFile.path, publicWeb.jsonLdHelperFile.content);
+    writeFileReplacing(workspaceRoot, publicWeb.routeMetadataFile.path, publicWeb.routeMetadataFile.content);
+    writeFileReplacing(workspaceRoot, publicWeb.routeHeadFile.path, publicWeb.routeHeadFile.content);
+    for (const generatedFile of publicWeb.routeMetaFiles)writeFileReplacing(workspaceRoot, generatedFile.path, generatedFile.content);
+    rewriteWorkspaceAssetsForApp(workspaceRoot, shellHost);
+    writeFileReplacing(workspaceRoot, `${shellApp.directory}/src/modern.runtime.ts`, createAppRuntimeConfig(shellHost, scope, remotes));
+    writeJsonFile(node_path.join(workspaceRoot, `${shellApp.directory}/locales/en/translation.json`), createAppPublicLocaleMessages(shellHost, 'en', remotes));
+    writeJsonFile(node_path.join(workspaceRoot, `${shellApp.directory}/locales/en/${appI18nNamespace(shellHost)}.json`), createAppPublicLocaleMessages(shellHost, 'en', remotes));
+    writeJsonFile(node_path.join(workspaceRoot, `${shellApp.directory}/locales/cs/translation.json`), createAppPublicLocaleMessages(shellHost, 'cs', remotes));
+    writeJsonFile(node_path.join(workspaceRoot, `${shellApp.directory}/locales/cs/${appI18nNamespace(shellHost)}.json`), createAppPublicLocaleMessages(shellHost, 'cs', remotes));
+    writeFileReplacing(workspaceRoot, `${shellApp.directory}/module-federation.config.ts`, createShellModuleFederationConfig(scope, remotes));
+    writeFileReplacing(workspaceRoot, `${shellApp.directory}/src/routes/[lang]/page.tsx`, createShellPage(remotes));
+    writeFileReplacing(workspaceRoot, `${shellApp.directory}/src/routes/vertical-components.tsx`, createShellRemoteComponents(scope, remotes));
+    writeFileReplacing(workspaceRoot, `${shellApp.directory}/src/routes/shell-frame.tsx`, createShellFrameComponent());
+    writeFileReplacing(workspaceRoot, `${shellApp.directory}/src/api/vertical-clients.ts`, createShellApiClient(scope, remotes));
+}
+function addShellZephyrDependency(workspaceRoot, scope, remote) {
+    const packagePath = node_path.join(workspaceRoot, shellApp.directory, 'package.json');
+    const shellPackage = readJsonFile(packagePath);
+    shellPackage['zephyr:dependencies'] ??= {};
+    shellPackage['zephyr:dependencies'][remoteDependencyAlias(remote)] = zephyrRemoteDependency(scope, remote);
+    writeJsonFile(packagePath, shellPackage);
+}
+function addShellWorkspaceDependency(workspaceRoot, scope, remote) {
+    if (!appHasApi(remote)) return;
+    const packagePath = node_path.join(workspaceRoot, shellApp.directory, 'package.json');
+    const shellPackage = readJsonFile(packagePath);
+    shellPackage.dependencies ??= {};
+    shellPackage.dependencies[packageName(scope, remote.packageSuffix)] = WORKSPACE_PACKAGE_VERSION;
+    writeJsonFile(packagePath, shellPackage);
+}
+export { addShellWorkspaceDependency, addShellZephyrDependency, rewriteShellAppFiles, updateRootWorkspaceScripts };

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

@@ -0,0 +1,90 @@
+import "node:module";
+import { apiTopologyMetadata } from "../api.js";
+import { createBackendFederationContract } from "../backend-federation.js";
+import { createDeliveryUnitRecord, deliveryUnitContractBlock } from "../delivery-unit.js";
+import { createModuleFederationRemoteContracts, createNeutralOwnership, shellApp } from "../descriptors.js";
+import { packageName, toEnvSegment, toPascalCase } from "../naming.js";
+import { createCloudflareDeployContract } from "../policy.js";
+function verticalTopologyEntry(scope, vertical, remotes = []) {
+    return {
+        id: vertical.id,
+        kind: vertical.kind,
+        domain: vertical.domain,
+        package: packageName(scope, vertical.packageSuffix),
+        path: vertical.directory,
+        moduleFederation: {
+            role: 'remote',
+            name: vertical.mfName,
+            manifestUrl: `http://localhost:${vertical.port}/mf-manifest.json`,
+            exposes: Object.keys(vertical.exposes ?? {}),
+            ...vertical.verticalRefs?.length ? {
+                verticalRefs: vertical.verticalRefs,
+                remotes: createModuleFederationRemoteContracts(vertical, remotes)
+            } : {},
+            ssr: true,
+            fallbackTelemetryEvent: 'modernjs:mv-runtime-parity',
+            sharedContractVersion: 'mf-ssr-contract-v1'
+        },
+        ...createBackendFederationContract(scope, vertical) ? {
+            backendFederation: createBackendFederationContract(scope, vertical)
+        } : {},
+        ...vertical.api ? {
+            deliveryUnit: deliveryUnitContractBlock(createDeliveryUnitRecord(scope, vertical))
+        } : {},
+        ...apiTopologyMetadata(vertical) ? {
+            api: apiTopologyMetadata(vertical)
+        } : {},
+        cloudflare: createCloudflareDeployContract(scope, vertical),
+        ownership: vertical.ownership
+    };
+}
+function ownershipEntry(scope, owner) {
+    return {
+        id: owner.id,
+        package: packageName(scope, owner.packageSuffix),
+        path: owner.directory,
+        ownership: owner.ownership
+    };
+}
+function verticalsFromTopology(topology, ports) {
+    return (topology.verticals ?? []).map((vertical)=>{
+        const domain = vertical.domain ?? String(vertical.id);
+        const packageSuffix = vertical.package?.split('/').at(-1) ?? domain;
+        const apiTopology = vertical.api;
+        const api = apiTopology?.runtime === 'effect' ? {
+            stem: 'string' == typeof apiTopology.basePath ? apiTopology.basePath.split('/').filter(Boolean).at(-1) ?? domain : domain,
+            prefix: apiTopology.bff?.prefix ?? `/${domain}-api`,
+            consumedBy: Array.isArray(apiTopology.consumedBy) ? apiTopology.consumedBy : [
+                shellApp.id,
+                vertical.id
+            ]
+        } : void 0;
+        return {
+            id: vertical.id,
+            directory: 'string' == typeof vertical.path ? vertical.path : `verticals/${domain}`,
+            packageSuffix,
+            displayName: vertical.displayName ?? `${toPascalCase(domain)} Vertical`,
+            kind: 'vertical',
+            domain,
+            portEnv: `VERTICAL_${toEnvSegment(domain)}_PORT`,
+            port: 'number' == typeof ports[vertical.id] ? ports[vertical.id] : 0,
+            mfName: vertical.moduleFederation?.name ?? `vertical${toPascalCase(domain)}`,
+            ...Array.isArray(vertical.moduleFederation?.exposes) ? {
+                exposes: Object.fromEntries(vertical.moduleFederation.exposes.map((expose)=>[
+                        expose,
+                        './Route' === expose ? './src/federation-entry.tsx' : './Widget' === expose ? `./src/components/${domain}-widget.tsx` : ''
+                    ]))
+            } : {},
+            ...Array.isArray(vertical.moduleFederation?.verticalRefs) ? {
+                verticalRefs: vertical.moduleFederation.verticalRefs
+            } : Array.isArray(vertical.moduleFederation?.remotes) ? {
+                verticalRefs: vertical.moduleFederation.remotes.map((entry)=>entry.id).filter((id)=>'string' == typeof id)
+            } : {},
+            ...api ? {
+                api
+            } : {},
+            ownership: vertical.ownership ?? createNeutralOwnership(vertical.id)
+        };
+    });
+}
+export { ownershipEntry, verticalTopologyEntry, verticalsFromTopology };

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

@@ -0,0 +1,44 @@
+import "node:module";
+import node_fs from "node:fs";
+import node_path from "node:path";
+import { readUltramodernConfig } from "../../ultramodern-tooling/config.js";
+import { ULTRAMODERN_CONFIG_PATH } from "../descriptors.js";
+import { toKebabCase } from "../naming.js";
+import { resolvePackageSource } from "../package-source.js";
+import { FIRST_VERTICAL_PORT } from "./constants.js";
+function existingPackageSource(workspaceRoot, modernVersion, packageSource) {
+    if (packageSource) return resolvePackageSource({
+        targetDir: workspaceRoot,
+        packageName: node_path.basename(workspaceRoot),
+        modernVersion,
+        packageSource
+    });
+    const compactPath = node_path.join(workspaceRoot, ULTRAMODERN_CONFIG_PATH);
+    if (node_fs.existsSync(compactPath)) {
+        const compactConfig = readUltramodernConfig(workspaceRoot);
+        if (compactConfig.packageSource) return compactConfig.packageSource;
+    }
+    throw new Error(`Missing UltraModern workspace file: ${compactPath}`);
+}
+function existingTailwindEnabled(workspaceRoot) {
+    const compactPath = node_path.join(workspaceRoot, ULTRAMODERN_CONFIG_PATH);
+    if (node_fs.existsSync(compactPath)) return readUltramodernConfig(workspaceRoot).features.tailwind;
+    throw new Error(`Missing UltraModern workspace file: ${compactPath}`);
+}
+function existingBridgeConfig(workspaceRoot) {
+    const compactPath = node_path.join(workspaceRoot, ULTRAMODERN_CONFIG_PATH);
+    return node_fs.existsSync(compactPath) ? readUltramodernConfig(workspaceRoot).bridge : void 0;
+}
+function assertValidVerticalName(name) {
+    const normalized = toKebabCase(name);
+    if (!normalized || normalized !== name) throw new Error(`Invalid Vertical name "${name}". Use lowercase kebab-case.`);
+    return normalized;
+}
+function nextAvailablePort(ports) {
+    const numericPorts = Object.values(ports).filter((value)=>'number' == typeof value && Number.isFinite(value));
+    return Math.max(FIRST_VERTICAL_PORT - 1, ...numericPorts) + 1;
+}
+function assertCanCreate(workspaceRoot, relativePath) {
+    if (node_fs.existsSync(node_path.join(workspaceRoot, relativePath))) throw new Error(`Refusing to overwrite existing path: ${relativePath}`);
+}
+export { assertCanCreate, assertValidVerticalName, existingBridgeConfig, existingPackageSource, existingTailwindEnabled, nextAvailablePort };