@vercel/microfrontends 2.0.0 → 2.1.0

package/dist/utils/mfe-port.js

@@ -191,22 +191,38 @@ import { readFileSync } from "node:fs";
 import { parse } from "jsonc-parser";
 import fg from "fast-glob";
 
-// src/config/constants.ts
-var CONFIGURATION_FILENAMES = [
+// src/config/microfrontends/utils/get-config-file-name.ts
+var DEFAULT_CONFIGURATION_FILENAMES = [
   "microfrontends.jsonc",
   "microfrontends.json"
 ];
+function getPossibleConfigurationFilenames({
+  customConfigFilename
+}) {
+  if (customConfigFilename) {
+    if (!customConfigFilename.endsWith(".json") && !customConfigFilename.endsWith(".jsonc")) {
+      throw new Error(
+        `The VC_MICROFRONTENDS_CONFIG_FILE_NAME environment variable must end with '.json' or '.jsonc'. Received: ${customConfigFilename}`
+      );
+    }
+    return Array.from(
+      /* @__PURE__ */ new Set([customConfigFilename, ...DEFAULT_CONFIGURATION_FILENAMES])
+    );
+  }
+  return DEFAULT_CONFIGURATION_FILENAMES;
+}
 
 // src/config/microfrontends/utils/infer-microfrontends-location.ts
 var configCache = {};
 function findPackageWithMicrofrontendsConfig({
   repositoryRoot,
-  applicationContext
+  applicationContext,
+  customConfigFilename
 }) {
   const applicationName = applicationContext.name;
   try {
     const microfrontendsJsonPaths = fg.globSync(
-      `**/{${CONFIGURATION_FILENAMES.join(",")}}`,
+      `**/{${getPossibleConfigurationFilenames({ customConfigFilename }).join(",")}}`,
       {
         cwd: repositoryRoot,
         absolute: true,
@@ -262,6 +278,8 @@ Names of applications in \`microfrontends.json\` must match the Vercel Project n
 
 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 your Vercel Microfrontends configuration has a custom name, ensure the VC_MICROFRONTENDS_CONFIG_FILE_NAME environment variable is set, you can pull the vercel project environment variables using the "vercel env pull" command.
+
 If you suspect this is thrown in error, please reach out to the Vercel team.`,
         { type: "config", subtype: "inference_failed" }
       );
@@ -276,7 +294,7 @@ If you suspect this is thrown in error, please reach out to the Vercel team.`,
   }
 }
 function inferMicrofrontendsLocation(opts) {
-  const cacheKey = `${opts.repositoryRoot}-${opts.applicationContext.name}`;
+  const cacheKey = `${opts.repositoryRoot}-${opts.applicationContext.name}${opts.customConfigFilename ? `-${opts.customConfigFilename}` : ""}`;
   if (configCache[cacheKey]) {
     return configCache[cacheKey];
   }
@@ -342,8 +360,13 @@ function findPackageRoot(startDir) {
 // src/config/microfrontends/utils/find-config.ts
 import fs4 from "node:fs";
 import { join } from "node:path";
-function findConfig({ dir }) {
-  for (const filename of CONFIGURATION_FILENAMES) {
+function findConfig({
+  dir,
+  customConfigFilename
+}) {
+  for (const filename of getPossibleConfigurationFilenames({
+    customConfigFilename
+  })) {
     const maybeConfig = join(dir, filename);
     if (fs4.existsSync(maybeConfig)) {
       return maybeConfig;
@@ -410,7 +433,7 @@ var MicrofrontendConfigClient = class {
   static fromEnv(config) {
     if (!config) {
       throw new Error(
-        "Could not construct MicrofrontendConfigClient: configuration is empty or undefined. Did you set up your application with `withMicrofrontends`?"
+        "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"
       );
     }
     return new MicrofrontendConfigClient(JSON.parse(config));
@@ -550,10 +573,11 @@ function validatePathExpression(path7) {
         }
         if (token.pattern !== PATH_DEFAULT_PATTERN && // Allows (a|b|c) and ((?!a|b|c).*) regex
         // Only limited regex is supported for now, due to performance considerations
-        !/^(?<allowed>[\w]+(?:\|[^:|()]+)+)$|^\(\?!(?<disallowed>[\w]+(?:\|[^:|()]+)*)\)\.\*$/.test(
-          token.pattern
+        // Allows all letters, numbers, and hyphens. Other characters must be escaped.
+        !/^(?<allowed>[\w-~]+(?:\|[^:|()]+)+)$|^\(\?!(?<disallowed>[\w-~]+(?:\|[^:|()]+)*)\)\.\*$/.test(
+          token.pattern.replace(/\\./g, "")
         )) {
-          return `Path ${path7} cannot use unsupported regular expression wildcard`;
+          return `Path ${path7} cannot use unsupported regular expression wildcard. If the path includes special characters, they must be escaped with backslash (e.g. '\\(')`;
         }
         if (token.modifier && i !== tokens.length - 1) {
           return `Modifier ${token.modifier} is not allowed on wildcard :${token.name} in ${path7}. Modifiers are only allowed in the last path component`;
@@ -1445,7 +1469,11 @@ var MicrofrontendsServer = class {
         appName,
         packageRoot
       });
-      const maybeConfig = findConfig({ dir: packageRoot });
+      const customConfigFilename = process.env.VC_MICROFRONTENDS_CONFIG_FILE_NAME;
+      const maybeConfig = findConfig({
+        dir: packageRoot,
+        customConfigFilename
+      });
       if (maybeConfig) {
         return MicrofrontendsServer.fromFile({
           filePath: maybeConfig,
@@ -1454,11 +1482,9 @@ var MicrofrontendsServer = class {
       }
       const repositoryRoot = findRepositoryRoot();
       const isMonorepo2 = isMonorepo({ repositoryRoot });
-      if (typeof process.env.VC_MICROFRONTENDS_CONFIG === "string") {
-        const maybeConfigFromEnv = resolve(
-          packageRoot,
-          process.env.VC_MICROFRONTENDS_CONFIG
-        );
+      const configFromEnv = process.env.VC_MICROFRONTENDS_CONFIG;
+      if (typeof configFromEnv === "string") {
+        const maybeConfigFromEnv = resolve(packageRoot, configFromEnv);
         if (maybeConfigFromEnv) {
           return MicrofrontendsServer.fromFile({
             filePath: maybeConfigFromEnv,
@@ -1467,7 +1493,8 @@ var MicrofrontendsServer = class {
         }
       } else {
         const maybeConfigFromVercel = findConfig({
-          dir: join2(packageRoot, ".vercel")
+          dir: join2(packageRoot, ".vercel"),
+          customConfigFilename
         });
         if (maybeConfigFromVercel) {
           return MicrofrontendsServer.fromFile({
@@ -1478,9 +1505,13 @@ var MicrofrontendsServer = class {
         if (isMonorepo2) {
           const defaultPackage = inferMicrofrontendsLocation({
             repositoryRoot,
-            applicationContext
+            applicationContext,
+            customConfigFilename
+          });
+          const maybeConfigFromDefault = findConfig({
+            dir: defaultPackage,
+            customConfigFilename
           });
-          const maybeConfigFromDefault = findConfig({ dir: defaultPackage });
           if (maybeConfigFromDefault) {
             return MicrofrontendsServer.fromFile({
               filePath: maybeConfigFromDefault,
@@ -1556,19 +1587,19 @@ var MicrofrontendsServer = class {
 // src/utils/mfe-port.ts
 function mfePort(packageDir) {
   const { name: appName, version } = getPackageJson(packageDir);
-  const result = loadConfig({ packageDir, appName });
-  if (!result) {
-    throw new MicrofrontendError(
-      `Unable to determine configured port for ${appName}`,
-      { type: "config", subtype: "not_found" }
-    );
+  try {
+    const result = loadConfig({ packageDir, appName });
+    const { port } = result;
+    return {
+      name: appName,
+      version,
+      port
+    };
+  } catch (e) {
+    throw new Error(`Unable to determine configured port for ${appName}`, {
+      cause: e
+    });
   }
-  const { port } = result;
-  return {
-    name: appName,
-    version,
-    port
-  };
 }
 function getPackageJson(packageDir) {
   const filePath = path6.join(packageDir, "package.json");
@@ -1578,14 +1609,9 @@ function loadConfig({
   packageDir,
   appName
 }) {
-  let config;
-  try {
-    config = MicrofrontendsServer.infer({
-      directory: packageDir
-    });
-  } catch (e) {
-    return void 0;
-  }
+  const config = MicrofrontendsServer.infer({
+    directory: packageDir
+  });
   const app = config.config.getApplication(appName);
   const port = app.development.local.port ?? (app.development.local.protocol === "https" ? 443 : 80);
   return { port };