@vercel/microfrontends 0.9.0 → 0.10.1

package/dist/next/testing.js

@@ -12,7 +12,7 @@ import { WebNextRequest } from "next/dist/server/base-http/web";
 // src/config/types.ts
 var isDefaultApplicationConfig = (app) => app.default && typeof app.routing === "undefined";
 
-// src/config/micro-frontend-config.ts
+// src/config/microfrontend-config.ts
 import fs2 from "node:fs";
 
 // src/config-v2/microfrontends/server/utils/get-output-file-path.ts
@@ -40,14 +40,14 @@ function getOutputFilePath() {
 }
 
 // src/config/errors.ts
-var MicroFrontendError = class extends Error {
+var MicrofrontendError = class extends Error {
   constructor(message, opts) {
     super(message);
-    this.name = "MicroFrontendsError";
-    this.source = (opts == null ? void 0 : opts.source) ?? "@vercel/micro-frontends";
+    this.name = "MicrofrontendsError";
+    this.source = (opts == null ? void 0 : opts.source) ?? "@vercel/microfrontends";
     this.type = (opts == null ? void 0 : opts.type) ?? "unknown";
     this.subtype = opts == null ? void 0 : opts.subtype;
-    Error.captureStackTrace(this, MicroFrontendError);
+    Error.captureStackTrace(this, MicrofrontendError);
   }
   isKnown() {
     return this.type !== "unknown";
@@ -56,13 +56,13 @@ var MicroFrontendError = class extends Error {
     return !this.isKnown();
   }
   /**
-   * Converts an error to a MicroFrontendsError.
+   * Converts an error to a MicrofrontendsError.
    * @param original - The original error to convert.
-   * @returns The converted MicroFrontendsError.
+   * @returns The converted MicrofrontendsError.
    */
   static convert(original, opts) {
     if (opts == null ? void 0 : opts.fileName) {
-      const err = MicroFrontendError.convertFSError(original, opts.fileName);
+      const err = MicrofrontendError.convertFSError(original, opts.fileName);
       if (err) {
         return err;
       }
@@ -70,25 +70,25 @@ var MicroFrontendError = class extends Error {
     if (original.message.includes(
       "Code generation from strings disallowed for this context"
     )) {
-      return new MicroFrontendError(original.message, {
+      return new MicrofrontendError(original.message, {
         type: "config",
         subtype: "unsupported_validation_env",
         source: "ajv"
       });
     }
-    return new MicroFrontendError(original.message);
+    return new MicrofrontendError(original.message);
   }
   static convertFSError(original, fileName) {
     if (original instanceof Error && "code" in original) {
       if (original.code === "ENOENT") {
-        return new MicroFrontendError(`Could not find "${fileName}"`, {
+        return new MicrofrontendError(`Could not find "${fileName}"`, {
           type: "config",
           subtype: "unable_to_read_file",
           source: "fs"
         });
       }
       if (original.code === "EACCES") {
-        return new MicroFrontendError(
+        return new MicrofrontendError(
           `Permission denied while accessing "${fileName}"`,
           {
             type: "config",
@@ -99,7 +99,7 @@ var MicroFrontendError = class extends Error {
       }
     }
     if (original instanceof SyntaxError) {
-      return new MicroFrontendError(
+      return new MicrofrontendError(
         `Failed to parse "${fileName}": Invalid JSON format.`,
         {
           type: "config",
@@ -111,23 +111,23 @@ var MicroFrontendError = class extends Error {
     return null;
   }
   /**
-   * Handles an unknown error and returns a MicroFrontendsError instance.
+   * Handles an unknown error and returns a MicrofrontendsError instance.
    * @param err - The error to handle.
-   * @returns A MicroFrontendsError instance.
+   * @returns A MicrofrontendsError instance.
    */
   static handle(err, opts) {
-    if (err instanceof MicroFrontendError) {
+    if (err instanceof MicrofrontendError) {
       return err;
     }
     if (err instanceof Error) {
-      return MicroFrontendError.convert(err, opts);
+      return MicrofrontendError.convert(err, opts);
     }
     if (typeof err === "object" && err !== null) {
       if ("message" in err && typeof err.message === "string") {
-        return MicroFrontendError.convert(new Error(err.message), opts);
+        return MicrofrontendError.convert(new Error(err.message), opts);
       }
     }
-    return new MicroFrontendError("An unknown error occurred");
+    return new MicrofrontendError("An unknown error occurred");
   }
 };
 
@@ -210,27 +210,27 @@ var _Overrides = class {
     });
     return overridesConfig;
   }
-  static validOverrideDomainsForZone(microFrontendConfig, zone) {
+  static validOverrideDomainsForZone(microfrontendConfig, zone) {
     var _a, _b, _c, _d, _e;
-    const projectName = (_a = microFrontendConfig.getZone(zone).vercel) == null ? void 0 : _a.projectName;
+    const projectName = (_a = microfrontendConfig.getZone(zone).vercel) == null ? void 0 : _a.projectName;
     if (!projectName) {
-      return [microFrontendConfig.getZone(zone).production.host];
+      return [microfrontendConfig.getZone(zone).production.host];
     }
     const parsedProjectName = makeUrlSafe(projectName);
-    const previewDeploymentSuffix = (_c = (_b = microFrontendConfig.options) == null ? void 0 : _b.vercel) == null ? void 0 : _c.previewDeploymentSuffix;
-    const teamSlug = (_e = (_d = microFrontendConfig.options) == null ? void 0 : _d.vercel) == null ? void 0 : _e.teamSlug;
+    const previewDeploymentSuffix = (_c = (_b = microfrontendConfig.options) == null ? void 0 : _b.vercel) == null ? void 0 : _c.previewDeploymentSuffix;
+    const teamSlug = (_e = (_d = microfrontendConfig.options) == null ? void 0 : _d.vercel) == null ? void 0 : _e.teamSlug;
     if (!teamSlug && !previewDeploymentSuffix) {
-      return [microFrontendConfig.getZone(zone).production.host];
+      return [microfrontendConfig.getZone(zone).production.host];
     }
     const suffix = previewDeploymentSuffix ? `.${previewDeploymentSuffix}` : `-${teamSlug}.vercel.app`;
     return [
       `${parsedProjectName}-git-([a-zA-Z0-9-]+)${suffix}`,
-      microFrontendConfig.getZone(zone).production.host
+      microfrontendConfig.getZone(zone).production.host
     ];
   }
-  static validateOverrideDomain(microFrontendConfig, zone, domain) {
+  static validateOverrideDomain(microfrontendConfig, zone, domain) {
     return new RegExp(
-      `^${_Overrides.validOverrideDomainsForZone(microFrontendConfig, zone).join(
+      `^${_Overrides.validOverrideDomainsForZone(microfrontendConfig, zone).join(
         "|"
       )}$`
     ).test(domain);
@@ -312,7 +312,7 @@ var Application = class {
   static validate(name, app) {
     var _a, _b, _c, _d, _e;
     if (((_b = (_a = app.routing) == null ? void 0 : _a.assetPrefix) == null ? void 0 : _b.startsWith("/")) || ((_d = (_c = app.routing) == null ? void 0 : _c.assetPrefix) == null ? void 0 : _d.endsWith("/"))) {
-      throw new MicroFrontendError(
+      throw new MicrofrontendError(
         `Invalid assetPrefix for application "${name}". Must not start or end with a slash.`,
         { type: "zone", subtype: "invalid_asset_prefix" }
       );
@@ -323,13 +323,13 @@ var Application = class {
           continue;
         }
         if (p.endsWith("/")) {
-          throw new MicroFrontendError(
+          throw new MicrofrontendError(
             `Invalid path for application "${name}". ${p} must not end with a slash.`,
             { type: "zone", subtype: "invalid_path" }
           );
         }
         if (!p.startsWith("/")) {
-          throw new MicroFrontendError(
+          throw new MicrofrontendError(
             `Invalid path for application "${name}". ${p} must start with a slash.`,
             { type: "zone", subtype: "invalid_path" }
           );
@@ -363,10 +363,10 @@ var Application = class {
   }
 };
 
-// src/config/common/micro-frontend-config.ts
+// src/config/common/microfrontend-config.ts
 var SUPPORTED_VERSIONS = ["1"];
 var DEFAULT_LOCAL_PROXY_PORT = 3024;
-var MicroFrontendConfigCommon = class {
+var MicrofrontendConfigCommon = class {
   constructor({
     config,
     overrides
@@ -374,7 +374,7 @@ var MicroFrontendConfigCommon = class {
     this.zones = {};
     var _a, _b, _c;
     if (!SUPPORTED_VERSIONS.includes(config.version)) {
-      throw new MicroFrontendError(
+      throw new MicrofrontendError(
         `Unsupported version: ${config.version}. Supported versions are: ${SUPPORTED_VERSIONS.join(
           ", "
         )}`,
@@ -402,7 +402,7 @@ var MicroFrontendConfigCommon = class {
   static getConfigFromEnv() {
     const config = process.env.MFE_CONFIG;
     if (!config) {
-      throw new MicroFrontendError(`Missing "MFE_CONFIG" in environment.`, {
+      throw new MicrofrontendError(`Missing "MFE_CONFIG" in environment.`, {
         type: "config",
         subtype: "not_found_in_env"
       });
@@ -421,8 +421,8 @@ var MicroFrontendConfigCommon = class {
   getZone(name) {
     const zone = this.zones[name];
     if (!zone) {
-      throw new MicroFrontendError(
-        `Could not find micro-frontends configuration for application "${name}"`,
+      throw new MicrofrontendError(
+        `Could not find microfrontends configuration for application "${name}"`,
         {
           type: "zone",
           subtype: "not_found"
@@ -442,8 +442,8 @@ var MicroFrontendConfigCommon = class {
   getDefaultZone() {
     const zone = Object.values(this.zones).find((z) => z.default);
     if (!zone) {
-      throw new MicroFrontendError(
-        `Could not find default zone in micro-frontends configuration`,
+      throw new MicrofrontendError(
+        `Could not find default zone in microfrontends configuration`,
         {
           type: "zone",
           subtype: "not_found"
@@ -495,8 +495,8 @@ var MicroFrontendConfigCommon = class {
     };
   }
   write(_) {
-    throw new MicroFrontendError(
-      `Writing to file to disk requires using an instance of "MicroFrontendConfig".`,
+    throw new MicrofrontendError(
+      `Writing to file to disk requires using an instance of "MicrofrontendConfig".`,
       { type: "config", subtype: "unsupported_operation" }
     );
   }
@@ -675,10 +675,6 @@ var schema_default = {
             flag: {
               type: "string",
               description: "flag name that can be used to enable/disable all paths in the group"
-            },
-            routeToDefaultApplication: {
-              type: "boolean",
-              description: "True to route the request to the default application for this micro-frontends set-up. This must be `true` when using `flag` or when you want to use custom logic to make the routing decision for this group of paths."
             }
           }
         },
@@ -857,7 +853,7 @@ var validateSchema = (configString) => {
   const validate = ajv.compile(SCHEMA);
   const isValid = validate(parsedConfig);
   if (!isValid) {
-    throw new MicroFrontendError(
+    throw new MicrofrontendError(
       `Invalid config: ${ajv.errorsText(validate.errors)}`,
       { type: "config", subtype: "does_not_match_schema" }
     );
@@ -867,7 +863,7 @@ var validateSchema = (configString) => {
 var SUPPORTED_VERSIONS2 = ["1"];
 var validateVersion = (version) => {
   if (!SUPPORTED_VERSIONS2.includes(version)) {
-    throw new MicroFrontendError(
+    throw new MicrofrontendError(
       `Unsupported version: ${version}. Supported versions are: ${SUPPORTED_VERSIONS2.join(
         ", "
       )}`,
@@ -900,7 +896,7 @@ function validateMainPath(applicationConfigsById) {
           return !matcher.test(defaultRoute);
         });
         if (!isValid) {
-          throw new MicroFrontendError(
+          throw new MicrofrontendError(
             `default route "${defaultRoute}" cannot be used for "${id}" because it is matched by "${otherId}"`,
             { type: "config", subtype: "invalid_main_path" }
           );
@@ -913,7 +909,7 @@ function validateMainPath(applicationConfigsById) {
         return matcher.test(defaultRoute);
       });
       if (!isValid) {
-        throw new MicroFrontendError(
+        throw new MicrofrontendError(
           `default route "${defaultRoute}" is not included by the routing config for application "${id}"`,
           { type: "config", subtype: "invalid_main_path" }
         );
@@ -976,7 +972,7 @@ var validatePaths = (applicationConfigsById) => {
     );
   });
   if (errors.length) {
-    throw new MicroFrontendError(`Invalid paths: ${errors.join(", ")}`, {
+    throw new MicrofrontendError(`Invalid paths: ${errors.join(", ")}`, {
       type: "config",
       subtype: "conflicting_paths"
     });
@@ -1010,13 +1006,13 @@ function validatePathExpression(path3) {
 var validateDefaults = (applicationConfigsById) => {
   const defaultApplicationIds = Object.entries(applicationConfigsById).reduce((acc, [id, app]) => app.default ? [...acc, id] : acc, []);
   if (defaultApplicationIds.length === 0) {
-    throw new MicroFrontendError(
+    throw new MicrofrontendError(
       `No default application found. At least one application must be marked as default.`,
       { type: "config", subtype: "no_default_application" }
     );
   }
   if (defaultApplicationIds.length > 1) {
-    throw new MicroFrontendError(
+    throw new MicrofrontendError(
       `Only one default application is allowed. Found ${defaultApplicationIds.join(", ")}.`,
       { type: "config", subtype: "multiple_default_applications" }
     );
@@ -1028,7 +1024,7 @@ var validateOptions = (options) => {
     if (!/^[a-zA-Z]{2,}\.[a-zA-Z]{2,}$/.test(
       options.vercel.previewDeploymentSuffix
     )) {
-      throw new MicroFrontendError(
+      throw new MicrofrontendError(
         `Invalid preview deployment suffix: ${options.vercel.previewDeploymentSuffix}. Should have be formatted like "vercel.app".`,
         { type: "config", subtype: "invalid_preview_deployment_suffix" }
       );
@@ -1039,11 +1035,10 @@ var validateOptions = (options) => {
 // src/config/utils/convert.ts
 function convertV1RoutingToV2Routing(routing) {
   return routing.matches.map((group) => {
-    var _a, _b;
+    var _a;
     return {
       group: group.group,
       flag: (_a = group.options) == null ? void 0 : _a.flag,
-      routeToDefaultApplication: (_b = group.options) == null ? void 0 : _b.routeToDefaultApplication,
       paths: group.paths
     };
   });
@@ -1083,9 +1078,15 @@ function convertV1ConfigToV2Config(config, fromApp) {
       )
     };
   }
+  const defaultApplication = Object.entries(config.applications).find(
+    ([, application]) => application.default
+  );
+  if (!defaultApplication) {
+    throw new Error("No default application found in the config");
+  }
   return {
     ...common,
-    partOf: fromApp
+    partOf: defaultApplication[0]
   };
 }
 
@@ -1100,8 +1101,8 @@ function writeFile(outputPath, config, prettify) {
   );
 }
 
-// src/config/micro-frontend-config.ts
-var MicroFrontendConfig = class extends MicroFrontendConfigCommon {
+// src/config/microfrontend-config.ts
+var MicrofrontendConfig = class extends MicrofrontendConfigCommon {
   static validate(configString) {
     const config = validateSchema(configString);
     validateVersion(config.version);
@@ -1114,9 +1115,9 @@ var MicroFrontendConfig = class extends MicroFrontendConfigCommon {
   static fromEnv({
     cookies
   }) {
-    return new MicroFrontendConfigCommon({
-      config: MicroFrontendConfig.validate(
-        MicroFrontendConfigCommon.getConfigFromEnv()
+    return new MicrofrontendConfigCommon({
+      config: MicrofrontendConfig.validate(
+        MicrofrontendConfigCommon.getConfigFromEnv()
       ),
       overrides: Overrides.parseOverrides(cookies)
     });
@@ -1126,11 +1127,11 @@ var MicroFrontendConfig = class extends MicroFrontendConfigCommon {
   }) {
     try {
       const config = fs2.readFileSync(filePath, "utf-8");
-      return new MicroFrontendConfig({
-        config: MicroFrontendConfig.validate(config)
+      return new MicrofrontendConfig({
+        config: MicrofrontendConfig.validate(config)
       });
     } catch (e) {
-      throw MicroFrontendError.handle(e, {
+      throw MicrofrontendError.handle(e, {
         fileName: filePath
       });
     }
@@ -1175,7 +1176,7 @@ function expandWildcards(path3) {
 }
 function loadMicrofrontendConfigForEdge(path3) {
   const rawMfConfig = parse2(readFileSync(path3, "utf-8"));
-  return new MicroFrontendConfig({ config: rawMfConfig });
+  return new MicrofrontendConfig({ config: rawMfConfig });
 }
 function getAllZoneNames(mfConfig) {
   return mfConfig.getAllApplications().filter((app) => !app.default).map((app) => app.name);
@@ -1237,12 +1238,12 @@ function urlMatches(middlewareConfig, path3, host) {
   }
   return false;
 }
-function validateMiddlewareConfig(middlewareConfig, microFrontendConfigOrPath, extraProductionMatches) {
+function validateMiddlewareConfig(middlewareConfig, microfrontendConfigOrPath, extraProductionMatches) {
   var _a, _b;
-  const microFrontendConfig = typeof microFrontendConfigOrPath === "string" ? loadMicrofrontendConfigForEdge(microFrontendConfigOrPath) : microFrontendConfigOrPath;
+  const microfrontendConfig = typeof microfrontendConfigOrPath === "string" ? loadMicrofrontendConfigForEdge(microfrontendConfigOrPath) : microfrontendConfigOrPath;
   const errors = [];
   const usedExtraProductionMatches = /* @__PURE__ */ new Set();
-  for (const application of microFrontendConfig.getAllApplications()) {
+  for (const application of microfrontendConfig.getAllApplications()) {
     if ((_a = application.routing) == null ? void 0 : _a.matches) {
       const matches = [...application.routing.matches];
       if (application.routing.assetPrefix) {
@@ -1259,14 +1260,14 @@ function validateMiddlewareConfig(middlewareConfig, microFrontendConfigOrPath, e
             if (!urlMatches(middlewareConfig, testPath, "test.nonproduction.host")) {
               errors.push(
                 `Matcher misconfigured for ${pathForDisplay}. This path should have matched the middleware config on a non-production host, but did not. Microfrontends require a middleware config matcher that matches on this host everywhere but in production. That can be configured with a configuration like this:
-${getSampleMatcher(path3, microFrontendConfig.getDefaultZone().production.host)}`
+${getSampleMatcher(path3, microfrontendConfig.getDefaultZone().production.host)}`
               );
               break;
             }
             const productionUrlMatches = urlMatches(
               middlewareConfig,
               testPath,
-              microFrontendConfig.getDefaultZone().production.host
+              microfrontendConfig.getDefaultZone().production.host
             );
             if (isFlagged) {
               if (!productionUrlMatches) {
@@ -1281,7 +1282,7 @@ ${getSampleMatcher(path3, microFrontendConfig.getDefaultZone().production.host)}
               } else {
                 errors.push(
                   `Matcher misconfigured for ${pathForDisplay}. This path matched the middleware config on a production host, but should not have. Microfrontends require a middleware config matcher that matches on this host everywhere but in production. If this is desired, you can add the path the to extraProductionMatches parameter. Otherwise, you can set up a configuration like this:
-${getSampleMatcher(path3, microFrontendConfig.getDefaultZone().production.host)}`
+${getSampleMatcher(path3, microfrontendConfig.getDefaultZone().production.host)}`
                 );
               }
               break;
@@ -1300,7 +1301,7 @@ ${getSampleMatcher(path3, microFrontendConfig.getDefaultZone().production.host)}
     );
   }
   if (errors.length > 0) {
-    const message = `Found the following inconsistencies between your microfrontend config ${typeof microFrontendConfigOrPath === "string" ? `(at ${microFrontendConfigOrPath}) ` : ""}and middleware config:
+    const message = `Found the following inconsistencies between your microfrontend config ${typeof microfrontendConfigOrPath === "string" ? `(at ${microfrontendConfigOrPath}) ` : ""}and middleware config:
 
 - `;
     throw new Error(message + errors.join("\n\n- "));
@@ -1316,26 +1317,26 @@ function getSampleMatcher(path3, host) {
     ],
   }`;
 }
-async function validateMiddlewareOnFlaggedPaths(microFrontendConfigOrPath, middleware) {
+async function validateMiddlewareOnFlaggedPaths(microfrontendConfigOrPath, middleware) {
   const initialEnv = process.env.VERCEL_ENV;
   const initialMfePreviewDomains = process.env.MFE_PREVIEW_DOMAINS;
   try {
-    const microFrontendConfig = typeof microFrontendConfigOrPath === "string" ? loadMicrofrontendConfigForEdge(microFrontendConfigOrPath) : microFrontendConfigOrPath;
-    const fakePreviewDomains = createFakePreviewDomains(microFrontendConfig);
+    const microfrontendConfig = typeof microfrontendConfigOrPath === "string" ? loadMicrofrontendConfigForEdge(microfrontendConfigOrPath) : microfrontendConfigOrPath;
+    const fakePreviewDomains = createFakePreviewDomains(microfrontendConfig);
     process.env.MFE_PREVIEW_DOMAINS = JSON.stringify(fakePreviewDomains);
-    const allZoneNames = getAllZoneNames(microFrontendConfig);
+    const allZoneNames = getAllZoneNames(microfrontendConfig);
     const errors = [];
     for (const zoneName of allZoneNames) {
       const flaggedPaths = getFlaggedPathsForZone(
-        microFrontendConfig,
+        microfrontendConfig,
         zoneName
       );
       if (flaggedPaths.length) {
         for (const env of ["preview", "production"]) {
           process.env.VERCEL_ENV = env;
           for (const path3 of flaggedPaths) {
-            const expectedHost = env === "preview" ? fakePreviewDomains[zoneName] : getExpectedDomainForZone(microFrontendConfig, zoneName, env);
-            const requestPath = `https://${microFrontendConfig.getDefaultZone().production.host}${path3}`;
+            const expectedHost = env === "preview" ? fakePreviewDomains[zoneName] : getExpectedDomainForZone(microfrontendConfig, zoneName, env);
+            const requestPath = `https://${microfrontendConfig.getDefaultZone().production.host}${path3}`;
             const request = new NextRequest(requestPath, {
               headers: { "x-vercel-skip-deployment-existence-check": "1" }
             });