@vercel/microfrontends 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -1,10 +1,18 @@
 # @vercel/microfrontends
 
+## 2.1.0
+
+### Minor Changes
+
+- c856a5d:
+  - Add support for custom `microfrontends.json` file names. This enables a single application to be deployed as multiple different vercel projects / microfrontends.
+  - Strip asset prefix from Vercel Firewall rate limit paths. Support Vercel Firewall rate limit requests when they go to a child application.
+
 ## 2.0.1
 
 ### Patch Changes
 
-- 8c11bdc: 
+- 8c11bdc:
   - Support hyphens and escaped special characters in supported path matching regex https://vercel.com/docs/microfrontends/path-routing#supported-path-expressions
   - Improve error message for when local development proxy can't determine the port
   - Update local proxy double slash routing behaviour to match the production proxy

package/README.md

@@ -1,8 +1,4 @@
-<picture>
-  <source srcset="https://assets.vercel.com/image/upload/v1689795055/docs-assets/static/docs/microfrontends/mfe-package-banner-dark.png" media="(prefers-color-scheme: dark)">
-  <source srcset="https://assets.vercel.com/image/upload/v1689795055/docs-assets/static/docs/microfrontends/mfe-package-banner-light.png" media="(prefers-color-scheme: light)">
-  <img src="https://assets.vercel.com/image/upload/v1689795055/docs-assets/static/docs/microfrontends/mfe-package-banner-dark.png" alt="hero banner">
-</picture>
+![hero banner](./assets/mfe-package-banner-dark.png)
 
 # @vercel/microfrontends
 

package/dist/bin/cli.cjs

@@ -30,7 +30,7 @@ var import_env = require("@next/env");
 // package.json
 var package_default = {
   name: "@vercel/microfrontends",
-  version: "2.0.1",
+  version: "2.1.0",
   private: false,
   description: "Defines configuration and utilities for microfrontends development",
   keywords: [
@@ -1112,22 +1112,38 @@ var import_node_fs2 = require("fs");
 var import_jsonc_parser2 = require("jsonc-parser");
 var import_fast_glob = __toESM(require("fast-glob"), 1);
 
-// 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 = import_fast_glob.default.globSync(
-      `**/{${CONFIGURATION_FILENAMES.join(",")}}`,
+      `**/{${getPossibleConfigurationFilenames({ customConfigFilename }).join(",")}}`,
       {
         cwd: repositoryRoot,
         absolute: true,
@@ -1183,6 +1199,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" }
       );
@@ -1197,7 +1215,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];
   }
@@ -1263,8 +1281,13 @@ function findPackageRoot(startDir) {
 // src/config/microfrontends/utils/find-config.ts
 var import_node_fs5 = __toESM(require("fs"), 1);
 var import_node_path5 = require("path");
-function findConfig({ dir }) {
-  for (const filename of CONFIGURATION_FILENAMES) {
+function findConfig({
+  dir,
+  customConfigFilename
+}) {
+  for (const filename of getPossibleConfigurationFilenames({
+    customConfigFilename
+  })) {
     const maybeConfig = (0, import_node_path5.join)(dir, filename);
     if (import_node_fs5.default.existsSync(maybeConfig)) {
       return maybeConfig;
@@ -1696,7 +1719,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,
@@ -1705,11 +1732,9 @@ var MicrofrontendsServer = class {
       }
       const repositoryRoot = findRepositoryRoot();
       const isMonorepo2 = isMonorepo({ repositoryRoot });
-      if (typeof process.env.VC_MICROFRONTENDS_CONFIG === "string") {
-        const maybeConfigFromEnv = (0, import_node_path8.resolve)(
-          packageRoot,
-          process.env.VC_MICROFRONTENDS_CONFIG
-        );
+      const configFromEnv = process.env.VC_MICROFRONTENDS_CONFIG;
+      if (typeof configFromEnv === "string") {
+        const maybeConfigFromEnv = (0, import_node_path8.resolve)(packageRoot, configFromEnv);
         if (maybeConfigFromEnv) {
           return MicrofrontendsServer.fromFile({
             filePath: maybeConfigFromEnv,
@@ -1718,7 +1743,8 @@ var MicrofrontendsServer = class {
         }
       } else {
         const maybeConfigFromVercel = findConfig({
-          dir: (0, import_node_path8.join)(packageRoot, ".vercel")
+          dir: (0, import_node_path8.join)(packageRoot, ".vercel"),
+          customConfigFilename
         });
         if (maybeConfigFromVercel) {
           return MicrofrontendsServer.fromFile({
@@ -1729,9 +1755,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,

package/dist/experimental/sveltekit.cjs

@@ -232,22 +232,38 @@ var import_node_fs2 = require("fs");
 var import_jsonc_parser = require("jsonc-parser");
 var import_fast_glob = __toESM(require("fast-glob"), 1);
 
-// 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 = import_fast_glob.default.globSync(
-      `**/{${CONFIGURATION_FILENAMES.join(",")}}`,
+      `**/{${getPossibleConfigurationFilenames({ customConfigFilename }).join(",")}}`,
       {
         cwd: repositoryRoot,
         absolute: true,
@@ -303,6 +319,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" }
       );
@@ -317,7 +335,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];
   }
@@ -383,8 +401,13 @@ function findPackageRoot(startDir) {
 // src/config/microfrontends/utils/find-config.ts
 var import_node_fs5 = __toESM(require("fs"), 1);
 var import_node_path5 = require("path");
-function findConfig({ dir }) {
-  for (const filename of CONFIGURATION_FILENAMES) {
+function findConfig({
+  dir,
+  customConfigFilename
+}) {
+  for (const filename of getPossibleConfigurationFilenames({
+    customConfigFilename
+  })) {
     const maybeConfig = (0, import_node_path5.join)(dir, filename);
     if (import_node_fs5.default.existsSync(maybeConfig)) {
       return maybeConfig;
@@ -1487,7 +1510,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,
@@ -1496,11 +1523,9 @@ var MicrofrontendsServer = class {
       }
       const repositoryRoot = findRepositoryRoot();
       const isMonorepo2 = isMonorepo({ repositoryRoot });
-      if (typeof process.env.VC_MICROFRONTENDS_CONFIG === "string") {
-        const maybeConfigFromEnv = (0, import_node_path8.resolve)(
-          packageRoot,
-          process.env.VC_MICROFRONTENDS_CONFIG
-        );
+      const configFromEnv = process.env.VC_MICROFRONTENDS_CONFIG;
+      if (typeof configFromEnv === "string") {
+        const maybeConfigFromEnv = (0, import_node_path8.resolve)(packageRoot, configFromEnv);
         if (maybeConfigFromEnv) {
           return MicrofrontendsServer.fromFile({
             filePath: maybeConfigFromEnv,
@@ -1509,7 +1534,8 @@ var MicrofrontendsServer = class {
         }
       } else {
         const maybeConfigFromVercel = findConfig({
-          dir: (0, import_node_path8.join)(packageRoot, ".vercel")
+          dir: (0, import_node_path8.join)(packageRoot, ".vercel"),
+          customConfigFilename
         });
         if (maybeConfigFromVercel) {
           return MicrofrontendsServer.fromFile({
@@ -1520,9 +1546,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,