@vercel/microfrontends 2.1.2 → 2.2.0

package/dist/utils/mfe-port.cjs

@@ -227,8 +227,8 @@ var import_fast_glob = __toESM(require("fast-glob"), 1);
 
 // src/config/microfrontends/utils/get-config-file-name.ts
 var DEFAULT_CONFIGURATION_FILENAMES = [
-  "microfrontends.jsonc",
-  "microfrontends.json"
+  "microfrontends.json",
+  "microfrontends.jsonc"
 ];
 function getPossibleConfigurationFilenames({
   customConfigFilename
@@ -236,7 +236,7 @@ function getPossibleConfigurationFilenames({
   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}`
+        `Found VC_MICROFRONTENDS_CONFIG_FILE_NAME but the name is invalid. Received: ${customConfigFilename}. The file name must end with '.json' or '.jsonc'. It's also possible for the env var to include the path, eg microfrontends-dev.json or /path/to/microfrontends-dev.json.`
       );
     }
     return Array.from(
@@ -284,7 +284,7 @@ function findPackageWithMicrofrontendsConfig({
             }
           }
         }
-      } catch (error) {
+      } catch (error2) {
       }
     }
     if (matchingPaths.length > 1) {
@@ -320,9 +320,9 @@ If you suspect this is thrown in error, please reach out to the Vercel team.`,
     }
     const [packageJsonPath] = matchingPaths;
     return (0, import_node_path2.dirname)(packageJsonPath);
-  } catch (error) {
-    if (error instanceof MicrofrontendError) {
-      throw error;
+  } catch (error2) {
+    if (error2 instanceof MicrofrontendError) {
+      throw error2;
     }
     return null;
   }
@@ -346,6 +346,30 @@ function inferMicrofrontendsLocation(opts) {
 // src/config/microfrontends/utils/is-monorepo.ts
 var import_node_fs3 = __toESM(require("fs"), 1);
 var import_node_path3 = __toESM(require("path"), 1);
+
+// src/bin/logger.ts
+function debug(...args) {
+  if (process.env.MFE_DEBUG) {
+    console.log(...args);
+  }
+}
+function info(...args) {
+  console.log(...args);
+}
+function warn(...args) {
+  console.warn(...args);
+}
+function error(...args) {
+  console.error(...args);
+}
+var logger = {
+  debug,
+  info,
+  warn,
+  error
+};
+
+// src/config/microfrontends/utils/is-monorepo.ts
 function isMonorepo({
   repositoryRoot
 }) {
@@ -367,8 +391,8 @@ function isMonorepo({
       import_node_fs3.default.readFileSync(packageJsonPath, "utf-8")
     );
     return packageJson.workspaces !== void 0;
-  } catch (error) {
-    console.error("Error determining if repository is a monorepo", error);
+  } catch (error2) {
+    logger.error("Error determining if repository is a monorepo", error2);
     return false;
   }
 }
@@ -1162,38 +1186,28 @@ var schema_default = {
       type: "object",
       properties: {
         $schema: {
-          type: "string"
+          type: "string",
+          description: "See https://openapi.vercel.sh/microfrontends.json."
         },
         version: {
           type: "string",
-          const: "1"
-        },
-        options: {
-          $ref: "#/definitions/Options"
+          const: "1",
+          description: "The version of the microfrontends config schema."
         },
         applications: {
           $ref: "#/definitions/ApplicationRouting",
-          description: "Mapping of application names to the routes that they host. Only needs to be defined in the application that owns the primary microfrontend domain"
+          description: "Mapping of Vercel project names to their microfrontend configurations."
+        },
+        options: {
+          $ref: "#/definitions/Options",
+          description: "Optional configuration options for the microfrontend."
         }
       },
       required: [
         "applications"
       ],
-      additionalProperties: false
-    },
-    Options: {
-      type: "object",
-      properties: {
-        disableOverrides: {
-          type: "boolean",
-          description: "If you want to disable the overrides for the site. For example, if you are managing rewrites between applications externally, you may wish to disable the overrides on the toolbar as they will have no effect."
-        },
-        localProxyPort: {
-          type: "number",
-          description: "The port number used by the local proxy server.\n\nThe default is `3024`."
-        }
-      },
-      additionalProperties: false
+      additionalProperties: false,
+      description: "The microfrontends configuration schema. See https://vercel.com/docs/microfrontends/configuration."
     },
     ApplicationRouting: {
       type: "object",
@@ -1201,8 +1215,9 @@ var schema_default = {
         $ref: "#/definitions/Application"
       },
       propertyNames: {
-        description: "The unique identifier for a Microfrontend Application.\n\nMust match the Vercel project name.\n\nNote: If this name does not also match the name used to run the application, (e.g. the `name` from the `package.json`), then the `packageName` field should be set."
-      }
+        description: "The Vercel project name of the microfrontend application.\n\nNote: If this name does not also match the name `name` from the `package.json`, set `packageName` with the name used in `package.json`.\n\nSee https://vercel.com/docs/microfrontends/configuration#application-naming."
+      },
+      description: "Mapping of Vercel project names to their microfrontend configurations."
     },
     Application: {
       anyOf: [
@@ -1212,14 +1227,15 @@ var schema_default = {
         {
           $ref: "#/definitions/ChildApplication"
         }
-      ]
+      ],
+      description: "The configuration for a microfrontend application. There must always be one default application."
     },
     DefaultApplication: {
       type: "object",
       properties: {
         packageName: {
           type: "string",
-          description: "The name used to run the application, e.g. the `name` field in the `package.json`.\n\nThis is used by the local proxy to map the application config to the locally running app.\n\nThis is only necessary when the application name does not match the `name` used in `package.json`."
+          description: "The name used to run the application, e.g. the `name` field in the `package.json`.\n\nThis is used by the local proxy to map the application config to the locally running app.\n\nThis is only necessary when the application name does not match the `name` used in `package.json`.\n\nSee https://vercel.com/docs/microfrontends/configuration#application-naming."
         },
         development: {
           $ref: "#/definitions/DefaultDevelopment",
@@ -1239,15 +1255,15 @@ var schema_default = {
             "number",
             "string"
           ],
-          description: "A local port number or host string that this application runs on when it is running locally. If passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTP. If omitted, the port defaults to a unique, but stable (based on the application name) number.\n\nExamples of valid values:\n- 8080\n- my.localhost.me\n- my.localhost.me:8080\n- https://my.localhost.me\n- https://my.localhost.me:8080"
+          description: "A local port number or host that this application runs on when it is running locally. If passing a string, include the protocol (optional), host (required) and port (optional).\n\nExamples of valid values: 8080, my.localhost.me, my.localhost.me:8080, https://my.localhost.me, https://my.localhost.me:8080.\n\nThe default value is http://localhost:<port> where port is a stable, unique port number (based on the application name).\n\nSee https://vercel.com/docs/microfrontends/local-development."
         },
         task: {
           type: "string",
-          description: "Optional task to run when starting the development server. Should reference a script in the package.json of the application."
+          description: 'The task to run when starting the development server. Should reference a script in the package.json of the application.\n\nThe default value is "dev".\n\nSee https://vercel.com/docs/microfrontends/local-development.'
         },
         fallback: {
           type: "string",
-          description: "Fallback for local development, could point to any environment. This is required for the default app. This value is used as the fallback for child apps as well if they do not have a fallback.\n\nIf passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTPS. If omitted, the port defaults to `80` for HTTP and `443` for HTTPS."
+          description: "Fallback for local development, could point to any environment. This is required for the default app. This value is used as the fallback for child apps as well if they do not have a fallback.\n\nIf passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTPS. If omitted, the port defaults to `80` for HTTP and `443` for HTTPS.\n\nSee https://vercel.com/docs/microfrontends/local-development."
         }
       },
       required: [
@@ -1260,7 +1276,7 @@ var schema_default = {
       properties: {
         packageName: {
           type: "string",
-          description: "The name used to run the application, e.g. the `name` field in the `package.json`.\n\nThis is used by the local proxy to map the application config to the locally running app.\n\nThis is only necessary when the application name does not match the `name` used in `package.json`."
+          description: "The name used to run the application, e.g. the `name` field in the `package.json`.\n\nThis is used by the local proxy to map the application config to the locally running app.\n\nThis is only necessary when the application name does not match the `name` used in `package.json`.\n\nSee https://vercel.com/docs/microfrontends/configuration#application-naming."
         },
         development: {
           $ref: "#/definitions/ChildDevelopment",
@@ -1268,11 +1284,11 @@ var schema_default = {
         },
         routing: {
           $ref: "#/definitions/Routing",
-          description: "Groups of path expressions that are routed to this application."
+          description: "Groups of path expressions that are routed to this application.\n\nSee https://vercel.com/docs/microfrontends/path-routing."
         },
         assetPrefix: {
           type: "string",
-          description: "The name of the asset prefix to use instead of the auto-generated name.\n\nThe asset prefix is used to prefix all paths to static assets, such as JS, CSS, or images that are served by a specific application. It is necessary to ensure there are no conflicts with other applications on the same domain.\n\nAn auto-generated asset prefix of the form `vc-ap-<hash>` is used when this field is not provided.\n\nWhen this field is provided, `/${assetPrefix}/:path*` must also be added to the list of paths in the `routing` field. Changing the asset prefix after a microfrontend application has already been deployed is not a forwards and backwards compatible change, and the asset prefix should be added to the `routing` field and deployed before setting the `assetPrefix` field."
+          description: "The name of the asset prefix to use instead of the auto-generated name.\n\nThe asset prefix is used to prefix all paths to static assets, such as JS, CSS, or images that are served by a specific application. It is necessary to ensure there are no conflicts with other applications on the same domain.\n\nAn auto-generated asset prefix of the form `vc-ap-<hash>` is used when this field is not provided.\n\nWhen this field is provided, `/${assetPrefix}/:path*` must also be added to the list of paths in the `routing` field. Changing the asset prefix after a microfrontend application has already been deployed is not a forwards and backwards compatible change, and the asset prefix should be added to the `routing` field and deployed before setting the `assetPrefix` field.\n\nThe default value is the auto-generated asset prefix of the form `vc-ap-<hash>`.\n\nSee https://vercel.com/docs/microfrontends/path-routing#asset-prefix."
         }
       },
       required: [
@@ -1288,15 +1304,15 @@ var schema_default = {
             "number",
             "string"
           ],
-          description: "A local port number or host string that this application runs on when it is running locally. If passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTP. If omitted, the port defaults to a unique, but stable (based on the application name) number.\n\nExamples of valid values:\n- 8080\n- my.localhost.me\n- my.localhost.me:8080\n- https://my.localhost.me\n- https://my.localhost.me:8080"
+          description: "A local port number or host that this application runs on when it is running locally. If passing a string, include the protocol (optional), host (required) and port (optional).\n\nExamples of valid values: 8080, my.localhost.me, my.localhost.me:8080, https://my.localhost.me, https://my.localhost.me:8080.\n\nThe default value is http://localhost:<port> where port is a stable, unique port number (based on the application name).\n\nSee https://vercel.com/docs/microfrontends/local-development."
         },
         task: {
           type: "string",
-          description: "Optional task to run when starting the development server. Should reference a script in the package.json of the application."
+          description: 'The task to run when starting the development server. Should reference a script in the package.json of the application.\n\nThe default value is "dev".\n\nSee https://vercel.com/docs/microfrontends/local-development.'
         },
         fallback: {
           type: "string",
-          description: "Fallback for local development, could point to any environment. This is optional for child apps. If not provided, the fallback of the default app will be used.\n\nIf passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTPS. If omitted, the port defaults to `80` for HTTP and `443` for HTTPS."
+          description: "Fallback for local development, could point to any environment. If not provided for child apps, the fallback of the default app will be used.\n\nIf passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTPS. If omitted, the port defaults to `80` for HTTP and `443` for HTTPS.\n\nSee https://vercel.com/docs/microfrontends/local-development."
         }
       },
       additionalProperties: false
@@ -1305,29 +1321,46 @@ var schema_default = {
       type: "array",
       items: {
         $ref: "#/definitions/PathGroup"
-      }
+      },
+      description: "A list of path groups that are routed to this application."
     },
     PathGroup: {
       type: "object",
       properties: {
         group: {
           type: "string",
-          description: "Optional group name for the paths"
+          description: "Group name for the paths."
         },
         flag: {
           type: "string",
-          description: "flag name that can be used to enable/disable all paths in the group"
+          description: "The name of the feature flag that controls routing for this group of paths. See https://vercel.com/docs/microfrontends/path-routing#routing-changes-safely-with-flags."
         },
         paths: {
           type: "array",
           items: {
             type: "string"
-          }
+          },
+          description: "A list of path expressions that are routed to this application. See https://vercel.com/docs/microfrontends/path-routing#supported-path-expressions."
         }
       },
       required: [
         "paths"
       ],
+      additionalProperties: false,
+      description: "A group of paths that is routed to this application."
+    },
+    Options: {
+      type: "object",
+      properties: {
+        disableOverrides: {
+          type: "boolean",
+          description: "If you want to disable the overrides for the site. For example, if you are managing rewrites between applications externally, you may wish to disable the overrides on the toolbar as they will have no effect.\n\nSee https://vercel.com/docs/microfrontends/managing-microfrontends/vercel-toolbar#routing-overrides."
+        },
+        localProxyPort: {
+          type: "number",
+          description: "The port number used by the local proxy server.\n\nThe default value is 3024.\n\nSee https://vercel.com/docs/microfrontends/local-development."
+        }
+      },
       additionalProperties: false
     }
   }
@@ -1346,19 +1379,19 @@ function formatAjvErrors(errors) {
     return [];
   }
   const errorMessages = [];
-  for (const error of errors) {
-    if (error.instancePath === "" && (error.keyword === "anyOf" || error.keyword === "required" && error.params.missingProperty === "partOf")) {
+  for (const error2 of errors) {
+    if (error2.instancePath === "" && (error2.keyword === "anyOf" || error2.keyword === "required" && error2.params.missingProperty === "partOf")) {
       continue;
     }
-    const instancePath = error.instancePath.slice(1);
+    const instancePath = error2.instancePath.slice(1);
     const formattedInstancePath = instancePath === "" ? "at the root" : `in field ${instancePath}`;
-    if (error.keyword === "required" && error.params.missingProperty === "routing" && instancePath.split("/").length === 2) {
+    if (error2.keyword === "required" && error2.params.missingProperty === "routing" && instancePath.split("/").length === 2) {
       errorMessages.push(
         `Unable to infer if ${instancePath} is the default app or a child app. This usually means that there is another error in the configuration.`
       );
-    } else if (error.keyword === "anyOf" && instancePath.split("/").length > 2) {
+    } else if (error2.keyword === "anyOf" && instancePath.split("/").length > 2) {
       const anyOfErrors = errors.filter(
-        (e) => e.instancePath === error.instancePath && e.keyword !== "anyOf"
+        (e) => e.instancePath === error2.instancePath && e.keyword !== "anyOf"
       );
       if (anyOfErrors.every((e) => e.keyword === "type")) {
         const allowedTypes = LIST_FORMATTER2.format(
@@ -1374,13 +1407,13 @@ function formatAjvErrors(errors) {
           `Invalid field for ${instancePath}. Possible error messages are ${LIST_FORMATTER2.format(anyOfErrors.map((e) => e.message ?? ""))}`
         );
       }
-    } else if (error.keyword === "additionalProperties" && !(error.params.additionalProperty === "routing" && instancePath.split("/").length === 2)) {
+    } else if (error2.keyword === "additionalProperties" && !(error2.params.additionalProperty === "routing" && instancePath.split("/").length === 2)) {
       errorMessages.push(
-        `Property '${error.params.additionalProperty}' is not allowed ${formattedInstancePath}`
+        `Property '${error2.params.additionalProperty}' is not allowed ${formattedInstancePath}`
       );
-    } else if (error.keyword === "required") {
+    } else if (error2.keyword === "required") {
       errorMessages.push(
-        `Property '${error.params.missingProperty}' is required ${formattedInstancePath}`
+        `Property '${error2.params.missingProperty}' is required ${formattedInstancePath}`
       );
     }
   }
@@ -1393,8 +1426,8 @@ function validateSchema(configString) {
   const isValid = validate(parsedConfig);
   if (!isValid) {
     throw new MicrofrontendError(
-      `Invalid microfrontends config:${formatAjvErrors(validate.errors).map((error) => `
- - ${error}`).join(
+      `Invalid microfrontends config:${formatAjvErrors(validate.errors).map((error2) => `
+ - ${error2}`).join(
         ""
       )}