@vercel/microfrontends 1.0.0 → 1.0.1-canary.1

package/dist/next/config.js

@@ -1,5 +1,11 @@
-// src/next/config/index.ts
-import fs6 from "node:fs";
+// src/bin/check-proxy.ts
+function displayLocalProxyInfo(port) {
+  const { MFE_PROXY_MESSAGE_PRINTED, TURBO_TASK_HAS_MFE_PROXY } = process.env;
+  if (TURBO_TASK_HAS_MFE_PROXY === "true" && MFE_PROXY_MESSAGE_PRINTED !== "true") {
+    process.env.MFE_PROXY_MESSAGE_PRINTED = "true";
+    console.log(`Microfrontends Proxy running on http://localhost:${port}`);
+  }
+}
 
 // src/config/microfrontends/server/index.ts
 import fs5 from "node:fs";
@@ -358,6 +364,48 @@ var validateConfigDefaultApplication = (applicationConfigsById) => {
     );
   }
 };
+var validateDeprecatedFields = (config) => {
+  const errors = [];
+  if (config.options?.vercel) {
+    errors.push(
+      `Configuration cannot contain deprecated field 'options.vercel'. Use 'options.disableOverrides' instead.`
+    );
+  }
+  if (config.options?.localProxy) {
+    errors.push(
+      `Configuration cannot contain deprecated field 'options.localProxy'. Use 'options.localProxyPort' instead.`
+    );
+  }
+  for (const [applicationId, application] of Object.entries(
+    config.applications
+  )) {
+    if (application.vercel) {
+      errors.push(
+        `Application '${applicationId}' cannot contain deprecated field 'vercel'. Use 'projectId' instead.`
+      );
+    }
+    if (application.production) {
+      errors.push(
+        `Application '${applicationId}' cannot contain deprecated field 'production'. Use 'development.fallback' instead.`
+      );
+    }
+    if (application.development?.local) {
+      errors.push(
+        `Application '${applicationId}' cannot contain deprecated field 'development.local'. Use 'developement.localPort' instead.`
+      );
+    }
+  }
+  if (errors.length) {
+    throw new MicrofrontendError(
+      `Microfrontends configuration file errors:
+- ${errors.join("\n- ")}`,
+      {
+        type: "config",
+        subtype: "depcrecated_field"
+      }
+    );
+  }
+};
 
 // src/config/microfrontends-config/isomorphic/utils/generate-asset-prefix.ts
 var PREFIX = "vc-ap";
@@ -568,7 +616,7 @@ var MicrofrontendConfigIsomorphic = class {
   }) {
     this.childApplications = {};
     MicrofrontendConfigIsomorphic.validate(config, opts);
-    const disableOverrides = config.options?.vercel?.disableOverrides ?? false;
+    const disableOverrides = config.options?.disableOverrides ?? config.options?.vercel?.disableOverrides ?? false;
     this.overrides = overrides && !disableOverrides ? overrides : void 0;
     this.isMainConfig = isMainConfig(config);
     if (isMainConfig(config)) {
@@ -625,6 +673,9 @@ var MicrofrontendConfigIsomorphic = class {
       if (!skipValidation.includes("defaultApplication")) {
         validateConfigDefaultApplication(c.applications);
       }
+      if (!skipValidation.includes("deprecatedFields")) {
+        validateDeprecatedFields(c);
+      }
     }
     return c;
   }
@@ -759,7 +810,7 @@ var MicrofrontendMainConfig = class extends MicrofrontendConfigIsomorphic {
   }) {
     super({ config, overrides, meta });
     this.isMainConfig = true;
-    const disableOverrides = config.options?.vercel?.disableOverrides ?? false;
+    const disableOverrides = config.options?.disableOverrides ?? config.options?.vercel?.disableOverrides ?? false;
     let defaultApplication;
     for (const [appId, appConfig] of Object.entries(config.applications)) {
       const appOverrides = !disableOverrides ? this.overrides?.applications[appId] : void 0;
@@ -1072,7 +1123,9 @@ var schema_default = {
           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"
         }
       },
-      required: ["applications"],
+      required: [
+        "applications"
+      ],
       additionalProperties: false
     },
     Options: {
@@ -1167,7 +1220,9 @@ var schema_default = {
           description: "Vercel project ID"
         }
       },
-      required: ["projectId"],
+      required: [
+        "projectId"
+      ],
       additionalProperties: false
     },
     HostConfig: {
@@ -1175,7 +1230,10 @@ var schema_default = {
       properties: {
         protocol: {
           type: "string",
-          enum: ["http", "https"],
+          enum: [
+            "http",
+            "https"
+          ],
           description: "The protocol to be used for the connection.\n- `http`: Hypertext Transfer Protocol (HTTP).\n- `https`: Secure Hypertext Transfer Protocol (HTTPS).\n\n*"
         },
         host: {
@@ -1187,7 +1245,9 @@ var schema_default = {
           description: "The port number to be used for the connection. Common values include `80` for HTTP and `443` for HTTPS."
         }
       },
-      required: ["host"],
+      required: [
+        "host"
+      ],
       additionalProperties: false
     },
     Development: {
@@ -1229,7 +1289,10 @@ var schema_default = {
         },
         protocol: {
           type: "string",
-          enum: ["http", "https"],
+          enum: [
+            "http",
+            "https"
+          ],
           description: "The protocol to be used for the connection.\n- `http`: Hypertext Transfer Protocol (HTTP).\n- `https`: Secure Hypertext Transfer Protocol (HTTPS).\n\n*"
         },
         port: {
@@ -1261,7 +1324,9 @@ var schema_default = {
           description: "Groups of path expressions that are routed to this application."
         }
       },
-      required: ["routing"],
+      required: [
+        "routing"
+      ],
       additionalProperties: false
     },
     Routing: {
@@ -1288,7 +1353,9 @@ var schema_default = {
           }
         }
       },
-      required: ["paths"],
+      required: [
+        "paths"
+      ],
       additionalProperties: false
     },
     ChildConfig: {
@@ -1309,7 +1376,9 @@ var schema_default = {
           description: "Applications that only serve a subset of the microfrontend routes only need to reference the name of the primary application that owns the full microfrontends configuration."
         }
       },
-      required: ["partOf"],
+      required: [
+        "partOf"
+      ],
       additionalProperties: false
     }
   }
@@ -1571,12 +1640,30 @@ var MicrofrontendsServer = class extends Microfrontends {
   }
 };
 
-// src/next/utils/check-proxy.ts
-function displayLocalProxyInfo(port) {
-  const { MFE_PROXY_MESSAGE_PRINTED, TURBO_TASK_HAS_MFE_PROXY } = process.env;
-  if (TURBO_TASK_HAS_MFE_PROXY === "true" && MFE_PROXY_MESSAGE_PRINTED !== "true") {
-    process.env.MFE_PROXY_MESSAGE_PRINTED = "true";
-    console.log(`Microfrontends Proxy running on http://localhost:${port}`);
+// src/config/microfrontends/utils/get-application-context.ts
+import fs6 from "node:fs";
+function getApplicationContext(opts) {
+  if (opts?.appName) {
+    return { name: opts.appName };
+  }
+  try {
+    const packageJsonString = fs6.readFileSync("./package.json", "utf-8");
+    const packageJson = JSON.parse(packageJsonString);
+    if (!packageJson.name) {
+      throw new MicrofrontendError(
+        `package.json file missing required field "name"`,
+        {
+          type: "packageJson",
+          subtype: "missing_field_name",
+          source: "@vercel/microfrontends/next"
+        }
+      );
+    }
+    return { name: packageJson.name };
+  } catch (err) {
+    throw MicrofrontendError.handle(err, {
+      fileName: "package.json"
+    });
   }
 }
 
@@ -1615,27 +1702,34 @@ function transform2(args) {
   };
 }
 
+// src/next/utils/route-to-local-proxy.ts
+function routeToLocalProxy() {
+  const isDevEnv = (process.env.VERCEL_ENV ?? "development") === "development";
+  return isDevEnv && Boolean(process.env.TURBO_TASK_HAS_MFE_PROXY);
+}
+
 // src/next/config/transforms/redirects.ts
 function transform3(args) {
   const { next, microfrontend, opts } = args;
   const isProduction2 = opts?.isProduction ?? false;
-  const isDevEnv = (process.env.VERCEL_ENV ?? "development") === "development";
-  const requireLocalProxyHeader = !isProduction2 && isDevEnv && Boolean(process.env.TURBO_TASK_HAS_MFE_PROXY) && !process.env.MFE_DISABLE_LOCAL_PROXY_REWRITE;
+  const requireLocalProxyHeader = routeToLocalProxy() && !isProduction2 && !process.env.MFE_DISABLE_LOCAL_PROXY_REWRITE;
   if (requireLocalProxyHeader) {
-    const proxyRedirect = {
-      source: "/:path*",
-      destination: `http://localhost:${microfrontend.getLocalProxyPort()}/:path*`,
-      permanent: false,
-      missing: [{ type: "header", key: "x-vercel-mfe-local-proxy-origin" }]
-    };
+    const proxyRedirects = [
+      {
+        source: "/:path*",
+        destination: `http://localhost:${microfrontend.getLocalProxyPort()}/:path*`,
+        permanent: false,
+        missing: [{ type: "header", key: "x-vercel-mfe-local-proxy-origin" }]
+      }
+    ];
     if (next.redirects && typeof next.redirects === "function") {
       const originalRedirectsFn = next.redirects;
       next.redirects = async () => {
         const originalRedirects = await originalRedirectsFn();
-        return [proxyRedirect, ...originalRedirects];
+        return [...proxyRedirects, ...originalRedirects];
       };
     } else {
-      next.redirects = async () => [proxyRedirect];
+      next.redirects = async () => proxyRedirects;
     }
   }
   return { next };
@@ -1989,30 +2083,6 @@ function isProduction(opts) {
   }
   return process.env.VERCEL_ENV === "production";
 }
-function getApplicationContext(opts) {
-  if (opts?.appName) {
-    return { name: opts.appName };
-  }
-  try {
-    const packageJsonString = fs6.readFileSync("./package.json", "utf-8");
-    const packageJson = JSON.parse(packageJsonString);
-    if (!packageJson.name) {
-      throw new MicrofrontendError(
-        `package.json file missing required field "name"`,
-        {
-          type: "packageJson",
-          subtype: "missing_field_name",
-          source: "@vercel/microfrontends/next"
-        }
-      );
-    }
-    return { name: packageJson.name };
-  } catch (err) {
-    throw MicrofrontendError.handle(err, {
-      fileName: "package.json"
-    });
-  }
-}
 function withMicrofrontends(nextConfig, opts) {
   if (opts?.debug) {
     process.env.MFE_DEBUG = "true";