@vercel/microfrontends
Version:
Defines configuration and utilities for microfrontends development
1 lines • 117 kB
Source Map (JSON)
{"version":3,"sources":["../../src/utils/mfe-port.ts","../../src/config/microfrontends/server/index.ts","../../src/bin/logger.ts","../../src/config/errors.ts","../../src/config/microfrontends-config/isomorphic/index.ts","../../src/config/overrides/constants.ts","../../src/config/overrides/is-override-cookie.ts","../../src/config/overrides/get-override-from-cookie.ts","../../src/config/overrides/parse-overrides.ts","../../src/config/schema/utils/is-default-app.ts","../../src/config/microfrontends-config/client/index.ts","../../src/config/microfrontends-config/utils/get-config-from-env.ts","../../src/config/microfrontends-config/isomorphic/constants.ts","../../src/config/microfrontends-config/isomorphic/utils/generate-port.ts","../../src/config/microfrontends-config/isomorphic/host.ts","../../src/config/microfrontends-config/isomorphic/utils/hash-application-name.ts","../../src/config/microfrontends-config/isomorphic/utils/generate-asset-prefix.ts","../../src/config/microfrontends-config/isomorphic/utils/generate-automation-bypass-env-var-name.ts","../../src/config/microfrontends-config/isomorphic/validation.ts","../../src/config/microfrontends-config/isomorphic/application.ts","../../src/config/microfrontends/utils/find-config.ts","../../src/config/microfrontends/utils/get-config-file-name.ts","../../src/config/microfrontends/utils/find-package-root.ts","../../src/config/microfrontends/utils/find-repository-root.ts","../../src/config/microfrontends/utils/get-application-context.ts","../../src/config/microfrontends/utils/infer-microfrontends-location.ts","../../src/config/microfrontends/utils/is-monorepo.ts","../../src/config/microfrontends/server/utils/get-output-file-path.ts","../../src/config/microfrontends/server/constants.ts","../../src/config/microfrontends/server/validation.ts","../../schema/schema.json","../../src/config/schema/utils/load.ts"],"sourcesContent":["import fs from 'node:fs';\nimport path from 'node:path';\nimport { MicrofrontendsServer } from '../config/microfrontends/server';\n\nexport interface MicrofrontendsPort {\n name: string;\n version: string;\n port: number;\n /** Whether the port was overridden via MFE_PORT env var */\n overridden?: boolean;\n}\n\ninterface PortResult {\n port: number;\n}\n\n/**\n * Environment variable to override the port for local development.\n * Useful when running multiple worktrees simultaneously.\n * Note: Only works when a single application is running locally.\n */\nexport const MFE_APP_PORT_ENV = 'MFE_APP_PORT';\n\nexport function mfePort(packageDir: string): MicrofrontendsPort {\n const { name: appName, version } = getPackageJson(packageDir);\n\n // Check for port override via environment variable\n const portOverride = process.env[MFE_APP_PORT_ENV];\n if (portOverride) {\n const port = Number.parseInt(portOverride, 10);\n if (!Number.isNaN(port) && port > 0 && port < 65536) {\n return {\n name: appName,\n version,\n port,\n overridden: true,\n };\n }\n }\n\n try {\n const result = loadConfig({ packageDir, appName });\n const { port } = result;\n return {\n name: appName,\n version,\n port,\n };\n } catch (e) {\n throw new Error(`Unable to determine configured port for ${appName}`, {\n cause: e,\n });\n }\n}\n\nfunction getPackageJson(packageDir: string): { name: string; version: string } {\n const filePath = path.join(packageDir, 'package.json');\n return JSON.parse(fs.readFileSync(filePath, 'utf-8')) as {\n name: string;\n version: string;\n };\n}\n\nfunction loadConfig({\n packageDir,\n appName,\n}: {\n packageDir: string;\n appName: string;\n}): PortResult {\n const config = MicrofrontendsServer.infer({\n directory: packageDir,\n });\n const app = config.config.getApplication(appName);\n const port =\n app.development.local.port ??\n (app.development.local.protocol === 'https' ? 443 : 80);\n return { port };\n}\n","import fs from 'node:fs';\nimport { dirname, join, resolve } from 'node:path';\nimport { logger } from '../../../bin/logger';\nimport { MicrofrontendError } from '../../errors';\nimport { MicrofrontendConfigIsomorphic } from '../../microfrontends-config/isomorphic';\nimport { getConfigStringFromEnv } from '../../microfrontends-config/utils/get-config-from-env';\nimport type { OverridesConfig } from '../../overrides';\nimport { parseOverrides } from '../../overrides';\nimport type { Config } from '../../schema/types';\nimport { isDefaultApp } from '../../schema/utils/is-default-app';\nimport { findConfig } from '../utils/find-config';\nimport { findPackageRoot } from '../utils/find-package-root';\nimport { findRepositoryRoot } from '../utils/find-repository-root';\nimport { getApplicationContext } from '../utils/get-application-context';\nimport { inferMicrofrontendsLocation } from '../utils/infer-microfrontends-location';\nimport { isMonorepo as isRepositoryMonorepo } from '../utils/is-monorepo';\nimport { getOutputFilePath } from './utils/get-output-file-path';\nimport { validateSchema } from './validation';\n\nclass MicrofrontendsServer {\n config: MicrofrontendConfigIsomorphic;\n\n constructor({\n config,\n overrides,\n }: {\n config: Config;\n overrides?: OverridesConfig;\n }) {\n this.config = new MicrofrontendConfigIsomorphic({ config, overrides });\n }\n\n /**\n * Writes the configuration to a file.\n */\n writeConfig(\n opts: { pretty?: boolean } = {\n pretty: true,\n },\n ): void {\n const outputPath = getOutputFilePath();\n\n // ensure the directory exists\n fs.mkdirSync(dirname(outputPath), { recursive: true });\n fs.writeFileSync(\n outputPath,\n JSON.stringify(\n this.config.toSchemaJson(),\n null,\n (opts.pretty ?? true) ? 2 : undefined,\n ),\n );\n }\n\n // --------- Static Methods ---------\n\n /**\n * Generates a MicrofrontendsServer instance from an unknown object.\n */\n static fromUnknown({\n config,\n cookies,\n }: {\n config: unknown;\n cookies?: { name: string; value: string }[];\n }): MicrofrontendsServer {\n const overrides = cookies ? parseOverrides(cookies) : undefined;\n if (typeof config === 'string') {\n return new MicrofrontendsServer({\n config: MicrofrontendsServer.validate(config),\n overrides,\n });\n }\n if (typeof config === 'object') {\n return new MicrofrontendsServer({\n config: config as Config,\n overrides,\n });\n }\n\n throw new MicrofrontendError(\n 'Invalid config: must be a string or an object',\n { type: 'config', subtype: 'does_not_match_schema' },\n );\n }\n\n /**\n * Generates a MicrofrontendsServer instance from the environment.\n * Uses additional validation that is only available when in a node runtime\n */\n static fromEnv({\n cookies,\n }: {\n cookies: { name: string; value: string }[];\n }): MicrofrontendsServer {\n return new MicrofrontendsServer({\n config: MicrofrontendsServer.validate(getConfigStringFromEnv()),\n overrides: parseOverrides(cookies),\n });\n }\n\n /**\n * Validates the configuration against the JSON schema\n */\n static validate(config: string | Config): Config {\n if (typeof config === 'string') {\n const c = validateSchema(config);\n return c;\n }\n return config;\n }\n\n /**\n * Looks up the configuration by inferring the package root and looking for a microfrontends config file. If a file is not found,\n * it will look for a package in the repository with a microfrontends file that contains the current application\n * and use that configuration.\n *\n * This can return either a Child or Main configuration.\n */\n static infer({\n appName,\n directory,\n filePath,\n cookies,\n }: {\n appName?: string;\n directory?: string;\n filePath?: string;\n cookies?: { name: string; value: string }[];\n } = {}): MicrofrontendsServer {\n logger.debug('[MFE Config] Starting config inference', {\n appName,\n directory: directory || process.cwd(),\n filePath,\n });\n\n if (filePath) {\n logger.debug('[MFE Config] Using explicit filePath:', filePath);\n return MicrofrontendsServer.fromFile({\n filePath,\n cookies,\n });\n }\n\n try {\n const packageRoot = findPackageRoot(directory);\n logger.debug('[MFE Config] Package root:', packageRoot);\n\n const applicationContext = getApplicationContext({\n appName,\n packageRoot,\n });\n logger.debug('[MFE Config] Application context:', applicationContext);\n\n const customConfigFilename =\n process.env.VC_MICROFRONTENDS_CONFIG_FILE_NAME;\n\n if (customConfigFilename) {\n logger.debug(\n '[MFE Config] Custom config filename from VC_MICROFRONTENDS_CONFIG_FILE_NAME:',\n customConfigFilename,\n );\n }\n\n // see if we have a config file at the package root\n const maybeConfig = findConfig({\n dir: packageRoot,\n customConfigFilename,\n });\n if (maybeConfig) {\n logger.debug('[MFE Config] Config found at package root:', maybeConfig);\n return MicrofrontendsServer.fromFile({\n filePath: maybeConfig,\n cookies,\n });\n }\n\n // if we don't have a microfrontends configuration file, see if we have another package in the repo that references this one\n const repositoryRoot = findRepositoryRoot();\n const isMonorepo = isRepositoryMonorepo({ repositoryRoot });\n logger.debug(\n '[MFE Config] Repository root:',\n repositoryRoot,\n 'Is monorepo:',\n isMonorepo,\n );\n\n const configFromEnv = process.env.VC_MICROFRONTENDS_CONFIG;\n // the environment variable, if specified, takes precedence over other inference methods\n if (typeof configFromEnv === 'string') {\n logger.debug(\n '[MFE Config] Checking VC_MICROFRONTENDS_CONFIG:',\n configFromEnv,\n );\n const maybeConfigFromEnv = resolve(packageRoot, configFromEnv);\n if (maybeConfigFromEnv) {\n logger.debug(\n '[MFE Config] Config loaded from VC_MICROFRONTENDS_CONFIG:',\n maybeConfigFromEnv,\n );\n return MicrofrontendsServer.fromFile({\n filePath: maybeConfigFromEnv,\n cookies,\n });\n }\n } else {\n // when the VC_MICROFRONTENDS_CONFIG environment variable is not set, try to find the config in the .vercel directory first\n const vercelDir = join(packageRoot, '.vercel');\n logger.debug(\n '[MFE Config] Searching for config in .vercel directory:',\n vercelDir,\n );\n const maybeConfigFromVercel = findConfig({\n dir: vercelDir,\n customConfigFilename,\n });\n if (maybeConfigFromVercel) {\n logger.debug(\n '[MFE Config] Config found in .vercel directory:',\n maybeConfigFromVercel,\n );\n return MicrofrontendsServer.fromFile({\n filePath: maybeConfigFromVercel,\n cookies,\n });\n }\n\n if (isMonorepo) {\n logger.debug(\n '[MFE Config] Inferring microfrontends location in monorepo for application:',\n applicationContext.name,\n );\n // find the default package\n const defaultPackage = inferMicrofrontendsLocation({\n repositoryRoot,\n applicationContext,\n customConfigFilename,\n });\n logger.debug(\n '[MFE Config] Inferred package location:',\n defaultPackage,\n );\n\n // see if we have a config file at the package root\n const maybeConfigFromDefault = findConfig({\n dir: defaultPackage,\n customConfigFilename,\n });\n if (maybeConfigFromDefault) {\n logger.debug(\n '[MFE Config] Config found in inferred package:',\n maybeConfigFromDefault,\n );\n return MicrofrontendsServer.fromFile({\n filePath: maybeConfigFromDefault,\n cookies,\n });\n }\n logger.debug('[MFE Config] No config found in inferred package');\n }\n }\n // will be caught below\n throw new MicrofrontendError(\n 'Unable to automatically infer the location of the `microfrontends.json` file. If your Vercel Microfrontends configuration is not in this repository, you can use the Vercel CLI to pull the Vercel Microfrontends configuration using the \"vercel microfrontends pull\" command, or you can specify the path manually using the VC_MICROFRONTENDS_CONFIG environment variable. If you suspect this is thrown in error, please reach out to the Vercel team.',\n { type: 'config', subtype: 'inference_failed' },\n );\n } catch (e) {\n if (e instanceof MicrofrontendError) {\n throw e;\n }\n const errorMessage = e instanceof Error ? e.message : String(e);\n // we were unable to infer\n throw new MicrofrontendError(\n `Unable to locate and parse the \\`microfrontends.json\\` configuration file. Original error message: ${errorMessage}`,\n { cause: e, type: 'config', subtype: 'inference_failed' },\n );\n }\n }\n\n /*\n * Generates a MicrofrontendsServer instance from a file.\n */\n static fromFile({\n filePath,\n cookies,\n }: {\n filePath: string;\n cookies?: { name: string; value: string }[];\n }): MicrofrontendsServer {\n try {\n logger.debug('[MFE Config] Reading config from file:', filePath);\n const configJson = fs.readFileSync(filePath, 'utf-8');\n const config = MicrofrontendsServer.validate(configJson);\n logger.debug(\n '[MFE Config] Config loaded with applications:',\n Object.keys(config.applications),\n );\n\n return new MicrofrontendsServer({\n config,\n overrides: cookies ? parseOverrides(cookies) : undefined,\n });\n } catch (e) {\n throw MicrofrontendError.handle(e, {\n fileName: filePath,\n });\n }\n }\n\n /*\n * Generates a MicrofrontendsServer instance from a file.\n */\n static fromMainConfigFile({\n filePath,\n overrides,\n }: {\n filePath: string;\n overrides?: OverridesConfig;\n }): MicrofrontendsServer {\n try {\n const config = fs.readFileSync(filePath, 'utf-8');\n const validatedConfig = MicrofrontendsServer.validate(config);\n const [defaultApplication] = Object.entries(validatedConfig.applications)\n .filter(([, app]) => isDefaultApp(app))\n .map(([name]) => name);\n // This should never get hit as MicrofrontendsServer.validate checks this if we're given a main config\n if (!defaultApplication) {\n throw new MicrofrontendError(\n 'No default application found. At least one application needs to be the default by omitting routing.',\n { type: 'config', subtype: 'no_default_application' },\n );\n }\n return new MicrofrontendsServer({\n config: validatedConfig,\n overrides,\n });\n } catch (e) {\n throw MicrofrontendError.handle(e, {\n fileName: filePath,\n });\n }\n }\n}\n\nexport { MicrofrontendsServer, getApplicationContext };\n","/* eslint-disable no-console */\n\nfunction debug(...args: unknown[]): void {\n if (process.env.MFE_DEBUG) {\n console.log(...args);\n }\n}\n\nfunction info(...args: unknown[]): void {\n console.log(...args);\n}\n\nfunction warn(...args: unknown[]): void {\n console.warn(...args);\n}\n\nfunction error(...args: unknown[]): void {\n console.error(...args);\n}\n\nexport const logger = {\n debug,\n info,\n warn,\n error,\n};\n","export type MicrofrontendErrorType =\n | 'config'\n | 'packageJson'\n | 'vercelJson'\n | 'application'\n | 'unknown';\n\nexport type MicrofrontendErrorSubtype =\n | 'not_found'\n | 'inference_failed'\n | 'not_found_in_env'\n | 'invalid_asset_prefix'\n | 'invalid_main_path'\n | 'does_not_match_schema'\n | 'unable_to_read_file'\n | 'unsupported_validation_env'\n | 'unsupported_version'\n | 'invalid_path'\n | 'invalid_permissions'\n | 'invalid_syntax'\n | 'missing_microfrontend_config_path'\n | 'unsupported_operation';\n\n// A mapping of error types to their subtypes.\ninterface TypeToSubtype {\n application:\n | 'invalid_asset_prefix'\n | 'invalid_path'\n | 'multiple_package_managers'\n | 'not_found';\n config:\n | 'conflicting_paths'\n | 'depcrecated_field'\n | 'does_not_match_schema'\n | 'invalid_main_path'\n | 'invalid_preview_deployment_suffix'\n | 'multiple_default_applications'\n | 'no_default_application'\n | 'not_found_in_env'\n | 'not_found'\n | 'inference_failed'\n | 'unable_to_read_file'\n | 'invalid_syntax'\n | 'invalid_permissions'\n | 'unsupported_operation'\n | 'unsupported_validation_env'\n | 'unsupported_version';\n packageJson:\n | 'missing_field_name'\n | 'unable_to_read_file'\n | 'invalid_permissions'\n | 'invalid_syntax';\n vercelJson:\n | 'missing_field_microfrontend_config_path'\n | 'unable_to_read_file'\n | 'invalid_permissions'\n | 'invalid_syntax';\n unknown: never;\n}\n\nexport type MicrofrontendErrorSource =\n | '@vercel/microfrontends'\n | '@vercel/microfrontends/next'\n | 'fs'\n | 'ajv';\n\nexport interface MicrofrontendErrorOptions<T extends MicrofrontendErrorType> {\n cause?: unknown;\n source?: MicrofrontendErrorSource;\n type?: T;\n subtype?: TypeToSubtype[T];\n}\n\ninterface HandleOptions {\n fileName?: string;\n}\n\nexport class MicrofrontendError<\n T extends MicrofrontendErrorType = 'unknown',\n> extends Error {\n public source: MicrofrontendErrorSource;\n public type: T;\n public subtype?: TypeToSubtype[T];\n\n constructor(message: string, opts?: MicrofrontendErrorOptions<T>) {\n super(message, { cause: opts?.cause });\n this.name = 'MicrofrontendsError';\n this.source = opts?.source ?? '@vercel/microfrontends';\n this.type = opts?.type ?? ('unknown' as T);\n this.subtype = opts?.subtype;\n Error.captureStackTrace(this, MicrofrontendError);\n }\n\n isKnown(): boolean {\n return this.type !== 'unknown';\n }\n\n isUnknown(): boolean {\n return !this.isKnown();\n }\n\n /**\n * Converts an error to a MicrofrontendsError.\n * @param original - The original error to convert.\n * @returns The converted MicrofrontendsError.\n */\n static convert(\n original: Error,\n opts?: HandleOptions,\n ): MicrofrontendError<MicrofrontendErrorType> {\n if (opts?.fileName) {\n const err = MicrofrontendError.convertFSError(original, opts.fileName);\n if (err) {\n return err;\n }\n }\n\n if (\n original.message.includes(\n 'Code generation from strings disallowed for this context',\n )\n ) {\n return new MicrofrontendError(original.message, {\n type: 'config',\n subtype: 'unsupported_validation_env',\n source: 'ajv',\n });\n }\n\n // unknown catch-all\n return new MicrofrontendError(original.message);\n }\n\n static convertFSError(\n original: Error,\n fileName: string,\n ): MicrofrontendError<MicrofrontendErrorType> | null {\n if (original instanceof Error && 'code' in original) {\n if (original.code === 'ENOENT') {\n return new MicrofrontendError(`Could not find \"${fileName}\"`, {\n type: 'config',\n subtype: 'unable_to_read_file',\n source: 'fs',\n });\n }\n if (original.code === 'EACCES') {\n return new MicrofrontendError(\n `Permission denied while accessing \"${fileName}\"`,\n {\n type: 'config',\n subtype: 'invalid_permissions',\n source: 'fs',\n },\n );\n }\n }\n\n if (original instanceof SyntaxError) {\n return new MicrofrontendError(\n `Failed to parse \"${fileName}\": Invalid JSON format.`,\n {\n type: 'config',\n subtype: 'invalid_syntax',\n source: 'fs',\n },\n );\n }\n\n return null;\n }\n\n /**\n * Handles an unknown error and returns a MicrofrontendsError instance.\n * @param err - The error to handle.\n * @returns A MicrofrontendsError instance.\n */\n static handle(\n err: unknown,\n opts?: HandleOptions,\n ): MicrofrontendError<MicrofrontendErrorType> {\n if (err instanceof MicrofrontendError) {\n return err as MicrofrontendError<MicrofrontendErrorType>;\n }\n\n // handle Error instances\n if (err instanceof Error) {\n return MicrofrontendError.convert(err, opts);\n }\n\n // handle object errors\n if (typeof err === 'object' && err !== null) {\n if ('message' in err && typeof err.message === 'string') {\n return MicrofrontendError.convert(new Error(err.message), opts);\n }\n }\n\n return new MicrofrontendError('An unknown error occurred');\n }\n}\n","import { parse } from 'jsonc-parser';\nimport { MicrofrontendError } from '../../errors';\nimport { type OverridesConfig, parseOverrides } from '../../overrides';\nimport type { Config } from '../../schema/types';\nimport { isDefaultApp } from '../../schema/utils/is-default-app';\nimport { MicrofrontendConfigClient } from '../client';\nimport type { ClientConfig } from '../client/types';\nimport { getConfigStringFromEnv } from '../utils/get-config-from-env';\nimport { ChildApplication, DefaultApplication } from './application';\nimport {\n DEFAULT_LOCAL_PROXY_PORT,\n MFE_LOCAL_PROXY_PORT_ENV,\n} from './constants';\nimport { hashApplicationName } from './utils/hash-application-name';\nimport {\n validateConfigDefaultApplication,\n validateConfigPaths,\n} from './validation';\n\n/**\n * A class to manage the microfrontends configuration.\n */\nexport class MicrofrontendConfigIsomorphic {\n config: Config;\n defaultApplication: DefaultApplication;\n childApplications: Record<string, ChildApplication> = {};\n overrides?: OverridesConfig;\n options?: Config['options'];\n\n private readonly serialized: {\n config: Config;\n overrides?: OverridesConfig;\n };\n\n constructor({\n config,\n overrides,\n }: {\n config: Config;\n overrides?: OverridesConfig;\n }) {\n // run validation on init\n MicrofrontendConfigIsomorphic.validate(config);\n\n const disableOverrides = config.options?.disableOverrides ?? false;\n this.overrides = overrides && !disableOverrides ? overrides : undefined;\n\n let defaultApplication: DefaultApplication | undefined;\n // create applications\n for (const [appId, appConfig] of Object.entries(config.applications)) {\n const appOverrides = !disableOverrides\n ? this.overrides?.applications[appId]\n : undefined;\n\n if (isDefaultApp(appConfig)) {\n defaultApplication = new DefaultApplication(appId, {\n app: appConfig,\n overrides: appOverrides,\n });\n } else {\n this.childApplications[appId] = new ChildApplication(appId, {\n app: appConfig,\n overrides: appOverrides,\n });\n }\n }\n\n // validate that this.defaultApplication is defined\n if (!defaultApplication) {\n throw new MicrofrontendError(\n 'Could not find default application in microfrontends configuration',\n {\n type: 'application',\n subtype: 'not_found',\n },\n );\n }\n this.defaultApplication = defaultApplication;\n\n this.config = config;\n this.options = config.options;\n this.serialized = {\n config,\n overrides,\n };\n }\n\n static validate(config: string | Config): Config {\n // let this throw if it's not valid JSON\n const c = typeof config === 'string' ? (parse(config) as Config) : config;\n\n validateConfigPaths(c.applications);\n validateConfigDefaultApplication(c.applications);\n\n return c;\n }\n\n static fromEnv({\n cookies,\n }: {\n cookies?: { name: string; value: string }[];\n }): MicrofrontendConfigIsomorphic {\n return new MicrofrontendConfigIsomorphic({\n config: parse(getConfigStringFromEnv()) as Config,\n overrides: parseOverrides(cookies ?? []),\n });\n }\n\n isOverridesDisabled(): boolean {\n return this.options?.disableOverrides ?? false;\n }\n\n getConfig(): Config {\n return this.config;\n }\n\n getApplicationsByType(): {\n defaultApplication?: DefaultApplication;\n applications: ChildApplication[];\n } {\n return {\n defaultApplication: this.defaultApplication,\n applications: Object.values(this.childApplications),\n };\n }\n\n getChildApplications(): ChildApplication[] {\n return Object.values(this.childApplications);\n }\n\n getAllApplications(): (DefaultApplication | ChildApplication)[] {\n return [\n this.defaultApplication,\n ...Object.values(this.childApplications),\n ].filter(Boolean);\n }\n\n getApplication(name: string): DefaultApplication | ChildApplication {\n // check the default\n if (\n this.defaultApplication.name === name ||\n this.defaultApplication.packageName === name\n ) {\n return this.defaultApplication;\n }\n const app =\n this.childApplications[name] ||\n Object.values(this.childApplications).find(\n (child) => child.packageName === name,\n );\n if (!app) {\n throw new MicrofrontendError(\n `Could not find microfrontends configuration for application \"${name}\". If the name in package.json differs from your Vercel Project name, set the \\`packageName\\` field for the application in \\`microfrontends.json\\` to ensure that the configuration can be found locally.`,\n {\n type: 'application',\n subtype: 'not_found',\n },\n );\n }\n\n return app;\n }\n\n hasApplication(name: string): boolean {\n try {\n this.getApplication(name);\n return true;\n } catch {\n return false;\n }\n }\n\n getApplicationByProjectName(\n projectName: string,\n ): DefaultApplication | ChildApplication | undefined {\n // check the default\n if (this.defaultApplication.name === projectName) {\n return this.defaultApplication;\n }\n\n return Object.values(this.childApplications).find(\n (app) => app.name === projectName,\n );\n }\n\n /**\n * Returns the default application.\n */\n getDefaultApplication(): DefaultApplication {\n return this.defaultApplication;\n }\n\n /**\n * Returns the configured port for the local proxy.\n * Can be overridden via MFE_LOCAL_PROXY_PORT environment variable.\n */\n getLocalProxyPort(): number {\n // Check for port override via environment variable\n const portOverride = process.env[MFE_LOCAL_PROXY_PORT_ENV];\n if (portOverride) {\n const port = Number.parseInt(portOverride, 10);\n if (!Number.isNaN(port) && port > 0 && port < 65536) {\n return port;\n }\n }\n return this.config.options?.localProxyPort ?? DEFAULT_LOCAL_PROXY_PORT;\n }\n\n toClientConfig(options?: {\n removeFlaggedPaths?: boolean;\n }): MicrofrontendConfigClient {\n const applications: ClientConfig['applications'] = Object.fromEntries(\n Object.entries(this.childApplications).map(([name, application]) => [\n hashApplicationName(name),\n {\n default: false,\n routing: application.routing,\n },\n ]),\n );\n\n applications[hashApplicationName(this.defaultApplication.name)] = {\n default: true,\n };\n\n return new MicrofrontendConfigClient(\n {\n applications,\n },\n {\n removeFlaggedPaths: options?.removeFlaggedPaths,\n },\n );\n }\n\n /**\n * Serializes the class back to the Schema type.\n *\n * NOTE: This is used when writing the config to disk and must always match the input Schema\n */\n toSchemaJson(): Config {\n return this.serialized.config;\n }\n\n serialize(): {\n config: Config;\n overrides?: OverridesConfig;\n } {\n return this.serialized;\n }\n}\n","// cookie name needs to match proxy\n// https://github.com/vercel/proxy/blob/fb00d723136ad539a194e4a851dd272010527c35/lib/routing/micro_frontends_overrides.lua#L7\nexport const OVERRIDES_COOKIE_PREFIX = 'vercel-micro-frontends-override';\nexport const OVERRIDES_ENV_COOKIE_PREFIX = `${OVERRIDES_COOKIE_PREFIX}:env:`;\n","import { OVERRIDES_COOKIE_PREFIX } from './constants';\n\nexport function isOverrideCookie(cookie: { name?: string }): boolean {\n return Boolean(cookie.name?.startsWith(OVERRIDES_COOKIE_PREFIX));\n}\n","import { OVERRIDES_ENV_COOKIE_PREFIX } from './constants';\nimport { isOverrideCookie } from './is-override-cookie';\n\nexport function getOverrideFromCookie(cookie: {\n name: string;\n value?: string | null;\n}): { application: string; host: string } | undefined {\n if (!isOverrideCookie(cookie) || !cookie.value) return;\n return {\n application: cookie.name.replace(OVERRIDES_ENV_COOKIE_PREFIX, ''),\n host: cookie.value,\n };\n}\n","import { getOverrideFromCookie } from './get-override-from-cookie';\nimport type { OverridesConfig } from './types';\n\nexport function parseOverrides(\n cookies: { name: string; value?: string | null }[],\n): OverridesConfig {\n const overridesConfig: OverridesConfig = { applications: {} };\n\n cookies.forEach((cookie) => {\n const override = getOverrideFromCookie(cookie);\n if (!override) return;\n overridesConfig.applications[override.application] = {\n environment: { host: override.host },\n };\n });\n\n return overridesConfig;\n}\n","import type { Application, DefaultApplication } from '../types';\n\nexport function isDefaultApp(a: Application): a is DefaultApplication {\n return !('routing' in a);\n}\n","import { pathToRegexp } from 'path-to-regexp';\nimport type { ClientConfig } from './types';\n\nexport interface MicrofrontendConfigClientOptions {\n removeFlaggedPaths?: boolean;\n}\n\nconst regexpCache = new Map<string, RegExp>();\nconst getRegexp = (path: string): RegExp => {\n const existing = regexpCache.get(path);\n if (existing) {\n return existing;\n }\n\n const regexp = pathToRegexp(path);\n regexpCache.set(path, regexp);\n return regexp;\n};\n\nexport class MicrofrontendConfigClient {\n applications: ClientConfig['applications'];\n hasFlaggedPaths: boolean;\n pathCache: Record<string, string> = {};\n private readonly serialized: ClientConfig;\n\n constructor(config: ClientConfig, opts?: MicrofrontendConfigClientOptions) {\n this.hasFlaggedPaths = config.hasFlaggedPaths ?? false;\n for (const app of Object.values(config.applications)) {\n if (app.routing) {\n if (app.routing.some((match) => match.flag)) {\n this.hasFlaggedPaths = true;\n }\n const newRouting = [];\n const pathsWithoutFlags = [];\n for (const group of app.routing) {\n if (group.flag) {\n if (opts?.removeFlaggedPaths) {\n continue;\n }\n if (group.group) {\n delete group.group;\n }\n newRouting.push(group);\n } else {\n pathsWithoutFlags.push(...group.paths);\n }\n }\n if (pathsWithoutFlags.length > 0) {\n newRouting.push({ paths: pathsWithoutFlags });\n }\n app.routing = newRouting;\n }\n }\n this.serialized = config;\n if (this.hasFlaggedPaths) {\n this.serialized.hasFlaggedPaths = this.hasFlaggedPaths;\n }\n this.applications = config.applications;\n }\n\n /**\n * Create a new `MicrofrontendConfigClient` from a JSON string.\n * Config must be passed in to remain framework agnostic\n */\n static fromEnv(config: string | undefined): MicrofrontendConfigClient {\n if (!config) {\n throw new Error(\n 'Could not construct MicrofrontendConfigClient: configuration is empty or undefined. Did you set up your application with `withMicrofrontends`? Is the local proxy running and this application is being accessed via the proxy port? See https://vercel.com/docs/microfrontends/local-development#setting-up-microfrontends-proxy',\n );\n }\n return new MicrofrontendConfigClient(JSON.parse(config) as ClientConfig);\n }\n\n isEqual(other: MicrofrontendConfigClient): boolean {\n return (\n this === other ||\n JSON.stringify(this.applications) === JSON.stringify(other.applications)\n );\n }\n\n getApplicationNameForPath(path: string): string | null {\n if (!path.startsWith('/')) {\n throw new Error(`Path must start with a /`);\n }\n\n if (this.pathCache[path]) {\n return this.pathCache[path];\n }\n\n const pathname = new URL(path, 'https://example.com').pathname;\n for (const [name, application] of Object.entries(this.applications)) {\n if (application.routing) {\n for (const group of application.routing) {\n for (const childPath of group.paths) {\n const regexp = getRegexp(childPath);\n if (regexp.test(pathname)) {\n this.pathCache[path] = name;\n return name;\n }\n }\n }\n }\n }\n const defaultApplication = Object.entries(this.applications).find(\n ([, application]) => application.default,\n );\n if (!defaultApplication) {\n return null;\n }\n\n this.pathCache[path] = defaultApplication[0];\n return defaultApplication[0];\n }\n\n serialize(): ClientConfig {\n return this.serialized;\n }\n}\n","import { MicrofrontendError } from '../../errors';\n\n/**\n * Utility to fetch the microfrontend configuration string from the environment.\n */\nexport function getConfigStringFromEnv(): string {\n const config = process.env.MFE_CONFIG;\n if (!config) {\n throw new MicrofrontendError(`Missing \"MFE_CONFIG\" in environment.`, {\n type: 'config',\n subtype: 'not_found_in_env',\n });\n }\n return config;\n}\n","export const DEFAULT_LOCAL_PROXY_PORT = 3024;\n\n/**\n * Environment variable to override the app port for development.\n * Useful when running multiple worktrees simultaneously.\n * Note: Only works when a single application is running locally.\n */\nexport const MFE_APP_PORT_ENV = 'MFE_APP_PORT';\n\n/**\n * Environment variable to override the local proxy port for development.\n * Useful when running multiple worktrees simultaneously.\n */\nexport const MFE_LOCAL_PROXY_PORT_ENV = 'MFE_LOCAL_PROXY_PORT';\n","export function generatePortFromName({\n name,\n minPort = 3000,\n maxPort = 8000,\n}: {\n name: string;\n minPort?: number;\n maxPort?: number;\n}): number {\n if (!name) {\n throw new Error('Name is required to generate a port');\n }\n\n // hash the name\n let hash = 0;\n for (let i = 0; i < name.length; i++) {\n hash = (hash << 5) - hash + name.charCodeAt(i);\n // Convert to 32-bit\n hash |= 0;\n }\n hash = Math.abs(hash);\n\n // Map the hash to the port range\n const range = maxPort - minPort;\n const port = minPort + (hash % range);\n\n return port;\n}\n","import type {\n LocalHostConfig as LocalHostConfigSchema,\n HostConfig as RemoteHostConfigSchema,\n} from '../../../bin/types';\nimport { MFE_APP_PORT_ENV } from './constants';\nimport { generatePortFromName } from './utils/generate-port';\n\ninterface HostOptions {\n isLocal?: boolean;\n}\n\nexport class Host {\n protocol: 'http' | 'https';\n host: string;\n port?: number;\n local: boolean | undefined;\n\n constructor(\n hostConfig: RemoteHostConfigSchema | string,\n options?: HostOptions,\n ) {\n if (typeof hostConfig === 'string') {\n ({\n protocol: this.protocol,\n host: this.host,\n port: this.port,\n } = Host.parseUrl(hostConfig));\n } else {\n const { protocol = 'https', host, port } = hostConfig;\n this.protocol = protocol;\n this.host = host;\n this.port = port;\n }\n this.local = options?.isLocal;\n }\n\n protected static parseUrl(\n url: string,\n defaultProtocol = 'https',\n ): {\n protocol: Host['protocol'];\n host: string;\n port?: number;\n } {\n let hostToParse = url;\n if (!/^https?:\\/\\//.exec(hostToParse)) {\n hostToParse = `${defaultProtocol}://${hostToParse}`;\n }\n const parsed = new URL(hostToParse);\n if (!parsed.hostname) {\n throw new Error(Host.getMicrofrontendsError(url, 'requires a host'));\n }\n if (parsed.hash) {\n throw new Error(\n Host.getMicrofrontendsError(url, 'cannot have a fragment'),\n );\n }\n if (parsed.username || parsed.password) {\n throw new Error(\n Host.getMicrofrontendsError(\n url,\n 'cannot have authentication credentials (username and/or password)',\n ),\n );\n }\n if (parsed.pathname !== '/') {\n throw new Error(Host.getMicrofrontendsError(url, 'cannot have a path'));\n }\n if (parsed.search) {\n throw new Error(\n Host.getMicrofrontendsError(url, 'cannot have query parameters'),\n );\n }\n const protocol = parsed.protocol.slice(0, -1) as Host['protocol'];\n return {\n protocol,\n host: parsed.hostname,\n port: parsed.port ? Number.parseInt(parsed.port, 10) : undefined,\n };\n }\n\n private static getMicrofrontendsError(url: string, message: string): string {\n return `Microfrontends configuration error: the URL ${url} in your microfrontends.json ${message}.`;\n }\n\n isLocal(): boolean {\n return this.local || this.host === 'localhost' || this.host === '127.0.0.1';\n }\n\n toString(): string {\n const url = this.toUrl();\n // strip the trailing slash\n return url.toString().replace(/\\/$/, '');\n }\n\n toUrl(): URL {\n const url = `${this.protocol}://${this.host}${this.port ? `:${this.port}` : ''}`;\n return new URL(url);\n }\n}\n\n/**\n * A Host subclass with defaults for locally running applications\n */\nexport class LocalHost extends Host {\n constructor({\n appName,\n local,\n }: {\n appName: string;\n local?: string | number | LocalHostConfigSchema;\n }) {\n // Check for MFE_APP_PORT first - this allows multi-worktree setups\n // to override the port for the local application\n const portOverride = process.env[MFE_APP_PORT_ENV];\n if (portOverride) {\n const overridePort = Number.parseInt(portOverride, 10);\n if (\n !Number.isNaN(overridePort) &&\n overridePort > 0 &&\n overridePort < 65536\n ) {\n super({\n protocol: 'http',\n host: 'localhost',\n port: overridePort,\n });\n return;\n }\n }\n\n let protocol: RemoteHostConfigSchema['protocol'];\n let host: string | undefined;\n let port: number | undefined;\n if (typeof local === 'number') {\n port = local;\n } else if (typeof local === 'string') {\n if (/^\\d+$/.test(local)) {\n port = Number.parseInt(local, 10);\n } else {\n const parsed = Host.parseUrl(local, 'http');\n protocol = parsed.protocol;\n host = parsed.host;\n port = parsed.port;\n }\n } else if (local) {\n protocol = local.protocol;\n host = local.host;\n port = local.port;\n }\n // set defaults for local\n super({\n protocol: protocol ?? 'http',\n host: host ?? 'localhost',\n port: port ?? generatePortFromName({ name: appName }),\n });\n }\n}\n","import md5 from 'md5';\n\nexport function hashApplicationName(name: string): string {\n if (!name) {\n throw new Error('Application name is required to generate hash');\n }\n\n return md5(name).substring(0, 6).padStart(6, '0');\n}\n","import { hashApplicationName } from './hash-application-name';\n\nconst PREFIX = 'vc-ap';\n\nexport function generateAssetPrefixFromName({\n name,\n}: {\n name: string;\n}): string {\n if (!name) {\n throw new Error('Name is required to generate an asset prefix');\n }\n\n return `${PREFIX}-${hashApplicationName(name)}`;\n}\n","export function generateAutomationBypassEnvVarName({\n name,\n}: {\n name: string;\n}): string {\n return `AUTOMATION_BYPASS_${name.toUpperCase().replace(/[^a-zA-Z0-9]/g, '_')}`;\n}\n","import { parse as parsePathRegexp, pathToRegexp } from 'path-to-regexp';\nimport { MicrofrontendError } from '../../errors';\nimport type {\n ApplicationId,\n ApplicationRouting,\n ChildApplication as ChildApplicationConfig,\n PathGroup,\n} from '../../schema/types';\nimport { isDefaultApp } from '../../schema/utils/is-default-app';\n\nconst LIST_FORMATTER = new Intl.ListFormat('en', {\n style: 'long',\n type: 'conjunction',\n});\n\nconst VALID_ASSET_PREFIX_REGEXP = /^[a-z](?:[a-z0-9-]*[a-z0-9])?$/;\n\n/**\n * Validate all paths in a configuration - ensures paths do not overlap\n */\nexport const validateConfigPaths = (\n applicationConfigsById?: ApplicationRouting,\n): void => {\n if (!applicationConfigsById) {\n return;\n }\n\n const pathsByApplicationId = new Map<\n PathGroup['paths'][number],\n {\n applications: ApplicationId[];\n matcher: RegExp;\n applicationId?: ApplicationId;\n }\n >();\n const errors: string[] = [];\n\n for (const [id, app] of Object.entries(applicationConfigsById)) {\n if (isDefaultApp(app)) {\n // default applications do not have routing\n continue;\n }\n\n for (const pathMatch of app.routing) {\n for (const path of pathMatch.paths) {\n const maybeError = validatePathExpression(path);\n if (maybeError) {\n errors.push(maybeError);\n } else {\n const existing = pathsByApplicationId.get(path);\n if (existing) {\n existing.applications.push(id);\n } else {\n pathsByApplicationId.set(path, {\n applications: [id],\n matcher: pathToRegexp(path),\n applicationId: id,\n });\n }\n }\n }\n }\n }\n const entries = Array.from(pathsByApplicationId.entries());\n\n for (const [path, { applications: ids, matcher, applicationId }] of entries) {\n if (ids.length > 1) {\n errors.push(\n `Duplicate path \"${path}\" for applications \"${ids.join(', ')}\"`,\n );\n }\n\n for (const [\n matchPath,\n { applications: matchIds, applicationId: matchApplicationId },\n ] of entries) {\n if (path === matchPath) {\n // we're comparing to ourselves, so skip\n continue;\n }\n\n if (applicationId === matchApplicationId) {\n // we're comparing to paths within our own application, which are allowed to overlap, so skip\n continue;\n }\n\n if (matcher.test(matchPath)) {\n const source = `\"${path}\" of application${ids.length > 0 ? 's' : ''} ${ids.join(', ')}`;\n const destination = `\"${matchPath}\" of application${matchIds.length > 0 ? 's' : ''} ${matchIds.join(', ')}`;\n\n errors.push(\n `Overlapping path detected between ${source} and ${destination}`,\n );\n }\n }\n }\n\n if (errors.length) {\n throw new MicrofrontendError(\n `Invalid paths: ${errors.join(', ')}. See supported paths in the documentation https://vercel.com/docs/microfrontends/path-routing#supported-path-expressions.`,\n {\n type: 'config',\n subtype: 'conflicting_paths',\n },\n );\n }\n};\n\n// From https://github.com/pillarjs/path-to-regexp/blob/75a92c3d7c42159f459ab42f346899152906ea8c/src/index.ts#L183-L184\nconst PATH_DEFAULT_PATTERNS = ['[^\\\\/#\\\\?]+?', '(?:(?!\\\\.)[^\\\\/#\\\\?])+?'];\n\nfunction validatePathExpression(path: string): string | undefined {\n try {\n const tokens = parsePathRegexp(path);\n if (/(?<!\\\\)\\{/.test(path)) {\n return `Optional paths are not supported: ${path}`;\n }\n if (/(?<!\\\\|\\()\\?/.test(path)) {\n return `Optional paths are not supported: ${path}`;\n }\n if (/\\/[^/]*(?<!\\\\):[^/]*(?<!\\\\):[^/]*/.test(path)) {\n return `Only one wildcard is allowed per path segment: ${path}`;\n }\n for (let i = 0; i < tokens.length; i++) {\n const token = tokens[i];\n if (token === undefined) {\n return `token ${i} in ${path} is undefined, this shouldn't happen`;\n }\n if (typeof token !== 'string') {\n if (!token.name) {\n return `Only named wildcards are allowed: ${path} (hint: add \":path\" to the wildcard)`;\n }\n if (\n !PATH_DEFAULT_PATTERNS.includes(token.pattern) &&\n // Allows (a|b|c) and ((?!a|b|c).*) regex\n // Only limited regex is supported for now, due to performance considerations\n // Allows all letters, numbers, and hyphens. Other characters must be escaped.\n !/^(?<allowed>[\\w-~]+(?:\\|[^:|()]+)+)$|^\\(\\?!(?<disallowed>[\\w-~]+(?:\\|[^:|()]+)*)\\)\\.\\*$/.test(\n token.pattern.replace(/\\\\./g, ''),\n )\n ) {\n return `Path ${path} cannot use unsupported regular expression wildcard. If the path includes special characters, they must be escaped with backslash (e.g. '\\\\(')`;\n }\n if (token.modifier && i !== tokens.length - 1) {\n return `Modifier ${token.modifier} is not allowed on wildcard :${token.name} in ${path}. Modifiers are only allowed in the last path component`;\n }\n }\n }\n } catch (e) {\n const message = e instanceof Error ? e.message : String(e);\n return `Path ${path} could not be parsed into regexp: ${message}`;\n }\n return undefined;\n}\n\n/**\n * Validate all paths in an application - ensures paths are the correct format\n */\nexport const validateAppPaths = (\n name: string,\n app: ChildApplicationConfig,\n): void => {\n // validate routes\n for (const group of app.routing) {\n for (const p of group.paths) {\n if (p === '/') {\n continue;\n }\n if (p.endsWith('/')) {\n throw new MicrofrontendError(\n `Invalid path for application \"${name}\". ${p} must not end with a slash.`,\n { type: 'application', subtype: 'invalid_path' },\n );\n }\n\n if (!p.startsWith('/')) {\n throw new MicrofrontendError(\n `Invalid path for application \"${name}\". ${p} must start with a slash.`,\n { type: 'application', subtype: 'invalid_path' },\n );\n }\n }\n }\n if (app.assetPrefix) {\n if (!VALID_ASSET_PREFIX_REGEXP.test(app.assetPrefix)) {\n throw new MicrofrontendError(\n `Invalid asset prefix for application \"${name}\". ${app.assetPrefix} must start with a lowercase letter and contain only lowercase letters, numbers, and hyphens.`,\n { type: 'application', subtype: 'invalid_asset_prefix' },\n );\n }\n if (\n app.assetPrefix !== `vc-ap-${name}` &&\n !app.routing.some(\n (group) =>\n group.paths.includes(`/${app.assetPrefix}/:path*`) && !group.flag,\n )\n ) {\n throw new MicrofrontendError(\n `When \\`assetPrefix\\` is specified, \\`/${app.assetPrefix}/:path*\\` must be added the routing paths for the application. Changing the asset prefix is not a forwards and backwards compatible change, and the custom asset prefix should be added to \\`paths\\` and deployed before setting the \\`assetPrefix\\` field.`,\n { type: 'application', subtype: 'invalid_asset_prefix' },\n );\n }\n }\n};\n\n/**\n * Make sure only one `Application` defines routing\n * */\nexport const validateConfigDefaultApplication = (\n applicationConfigsById?: ApplicationRouting,\n): void => {\n if (!applicationConfigsById) {\n return;\n }\n\n const applicationsWithoutRouting = Object.entries(\n applicationConfigsById,\n ).filter(([, app]) => isDefaultApp(app));\n const numApplicationsWithoutRouting = applicationsWithoutRouting.reduce(\n (acc) => {\n return acc + 1;\n },\n 0,\n );\n\n if (numApplicationsWithoutRouting === 0) {\n throw new MicrofrontendError(\n 'No default application found. At least one application needs to be the default by omitting routing.',\n { type: 'config', subtype: 'no_default_application' },\n );\n }\n\n if (numApplicationsWithoutRouting > 1) {\n const applicationNamesMissingRouting = applicationsWithoutRouting.map(\n ([name]) => name,\n );\n throw new MicrofrontendError(\n `All applications except for the default app must contain the \"routing\" field. Applications that are missing routing: ${LIST_FORMATTER.format(applicationNamesMissingRouting)}.`,\n { type: 'config', subtype: 'multiple_default_applications' },\n );\n }\n};\n","import type { ApplicationOverrideConfig } from '../../overrides';\nimport type {\n Application as ApplicationConfig,\n ChildApplication as ChildApplicationConfig,\n DefaultApplication as DefaultApplicationConfig,\n PathGroup,\n} from '../../schema/types';\nimport { Host, LocalHost } from './host';\nimport { generateAssetPrefixFromName } from './utils/generate-asset-prefix';\nimport { generateAutomationBypassEnvVarName } from './utils/generate-automation-bypass-env-var-name';\nimport { validateAppPaths } from './validation';\n\nexport class Application {\n readonly default: boolean;\n name: string;\n development: {\n local: LocalHost;\n fallback?: Host;\n };\n fallback?: Host;\n packageName?: string;\n overrides?: {\n environment?: Host;\n };\n readonly