@vercel/microfrontends 0.9.0 → 0.10.1

package/dist/next/config.js

@@ -1,7 +1,7 @@
 // src/next/config/index.ts
 import fs3 from "node:fs";
 
-// 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
@@ -29,14 +29,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";
@@ -45,13 +45,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;
       }
@@ -59,25 +59,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",
@@ -88,7 +88,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",
@@ -100,23 +100,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");
   }
 };
 
@@ -199,27 +199,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);
@@ -301,7 +301,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" }
       );
@@ -312,13 +312,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" }
           );
@@ -352,10 +352,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
@@ -363,7 +363,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(
           ", "
         )}`,
@@ -391,7 +391,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"
       });
@@ -410,8 +410,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"
@@ -431,8 +431,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"
@@ -484,8 +484,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" }
     );
   }
@@ -667,10 +667,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."
             }
           }
         },
@@ -849,7 +845,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" }
     );
@@ -859,7 +855,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(
         ", "
       )}`,
@@ -892,7 +888,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" }
           );
@@ -905,7 +901,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" }
         );
@@ -968,7 +964,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"
     });
@@ -1002,13 +998,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" }
     );
@@ -1020,7 +1016,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" }
       );
@@ -1031,11 +1027,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
     };
   });
@@ -1075,9 +1070,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]
   };
 }
 
@@ -1092,8 +1093,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);
@@ -1106,9 +1107,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)
     });
@@ -1118,11 +1119,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
       });
     }
@@ -1407,9 +1408,9 @@ function rewritesMapToArr(rewrites) {
   });
 }
 function transform4(args) {
-  const { next, microFrontend, zone } = args;
+  const { next, microfrontend, zone } = args;
   const buildBeforeFiles = () => {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d;
     const rewrites = /* @__PURE__ */ new Map();
     if ((_a = zone.routing) == null ? void 0 : _a.assetPrefix) {
       rewrites.set(`/${zone.routing.assetPrefix}/_next/:path+`, {
@@ -1424,7 +1425,7 @@ function transform4(args) {
       }
     }
     if (zone.isDefault()) {
-      for (const [_, z] of Object.entries(microFrontend.zones)) {
+      for (const [_, z] of Object.entries(microfrontend.zones)) {
         if (zone.name === z.name) {
           continue;
         }
@@ -1442,9 +1443,7 @@ function transform4(args) {
           });
         }
         for (const group of routing.matches) {
-          if ((_d = group.options) == null ? void 0 : _d.routeToDefaultApplication) {
-            continue;
-          } else if ((_e = group.options) == null ? void 0 : _e.flag) {
+          if ((_d = group.options) == null ? void 0 : _d.flag) {
             continue;
           } else {
             for (const source of group.paths) {
@@ -1498,14 +1497,14 @@ function transform4(args) {
 var formatDomainForServerAction = (domain) => domain.replace(/https?:\/\//, "");
 function transform5(args) {
   var _a;
-  const { next, zone, microFrontend } = args;
+  const { next, zone, microfrontend } = args;
   const zonesToAllow = [
     // this zone - this is included by default unless allowedOrigins is overridden (which we are)
     // so we re-add it here.
     zone,
-    // this is the default zone for the micro-frontend. Allow child zones to call server actions
+    // this is the default zone for the microfrontend. Allow child zones to call server actions
     // that are in the default zone.
-    microFrontend.getDefaultZone()
+    microfrontend.getDefaultZone()
   ];
   const existingServerActionConfig = (_a = next.experimental) == null ? void 0 : _a.serverActions;
   next.experimental = {
@@ -1530,8 +1529,8 @@ function transform5(args) {
 
 // src/next/config/transforms/webpack.ts
 function transform6(args) {
-  const { next, microFrontend } = args;
-  const previewDomains = process.env.VERCEL_ENV === "preview" ? microFrontend.getAllApplications().reduce(
+  const { next, microfrontend } = args;
+  const previewDomains = process.env.VERCEL_ENV === "preview" ? microfrontend.getAllApplications().reduce(
     (obj, app) => {
       obj[app.name] = getPreviewDomain(app);
       return obj;
@@ -1547,7 +1546,7 @@ function transform6(args) {
       if (isServer || nextRuntime === "edge") {
         config.plugins.push(
           new wpFromNext.EnvironmentPlugin({
-            MFE_CONFIG: JSON.stringify(microFrontend.serialize()),
+            MFE_CONFIG: JSON.stringify(microfrontend.serialize()),
             MFE_PREVIEW_DOMAINS: JSON.stringify(previewDomains)
           })
         );
@@ -1674,18 +1673,18 @@ function getConfigPath(opts) {
     const vercelJsonString = fs3.readFileSync("./vercel.json", "utf-8");
     const vercelJson = JSON.parse(vercelJsonString);
     if (!((_a = vercelJson.microFrontends) == null ? void 0 : _a.config)) {
-      throw new MicroFrontendError(
+      throw new MicrofrontendError(
         `vercel.json file missing required field "microFrontends.config"`,
         {
           type: "vercelJson",
           subtype: "missing_field_microFrontend_config_path",
-          source: "@vercel/micro-frontends/next"
+          source: "@vercel/microfrontends/next"
         }
       );
     }
     return { configPath: vercelJson.microFrontends.config };
   } catch (err) {
-    throw MicroFrontendError.handle(err, {
+    throw MicrofrontendError.handle(err, {
       fileName: "vercel.json"
     });
   }
@@ -1698,30 +1697,30 @@ function getApplicationContext(opts) {
     const packageJsonString = fs3.readFileSync("./package.json", "utf-8");
     const packageJson = JSON.parse(packageJsonString);
     if (!packageJson.name) {
-      throw new MicroFrontendError(
+      throw new MicrofrontendError(
         `package.json file missing required field "name"`,
         {
           type: "packageJson",
           subtype: "missing_field_name",
-          source: "@vercel/micro-frontends/next"
+          source: "@vercel/microfrontends/next"
         }
       );
     }
     return { name: packageJson.name };
   } catch (err) {
-    throw MicroFrontendError.handle(err, {
+    throw MicrofrontendError.handle(err, {
       fileName: "package.json"
     });
   }
 }
-function withMicroFrontends(nextConfig, opts) {
+function withMicrofrontends(nextConfig, opts) {
   var _a;
   if (opts == null ? void 0 : opts.debug) {
     process.env.MFE_DEBUG = "true";
   }
   const { name } = getApplicationContext(opts);
   const { configPath } = getConfigPath(opts);
-  const mfConfig = MicroFrontendConfig.fromFile({
+  const mfConfig = MicrofrontendConfig.fromFile({
     filePath: configPath
   });
   const zone = mfConfig.getZone(name);
@@ -1736,7 +1735,7 @@ function withMicroFrontends(nextConfig, opts) {
       const transformedConfig = transform7({
         zone,
         next,
-        microFrontend: mfConfig,
+        microfrontend: mfConfig,
         opts: {
           isProduction: isProduction(opts)
         }
@@ -1753,6 +1752,6 @@ function withMicroFrontends(nextConfig, opts) {
   return next;
 }
 export {
-  withMicroFrontends
+  withMicrofrontends
 };
 //# sourceMappingURL=config.js.map