@vercel/microfrontends 0.12.1 → 0.13.0

package/dist/bin/cli.cjs

@@ -29,7 +29,7 @@ var import_commander = require("commander");
 // package.json
 var package_default = {
   name: "@vercel/microfrontends",
-  version: "0.12.1",
+  version: "0.13.0",
   private: false,
   description: "Defines configuration and utilities for micro-frontend development",
   repository: {
@@ -119,73 +119,37 @@ var package_default = {
     "./v2/next/client": {
       import: "./dist/v2/next/client.js",
       require: "./dist/v2/next/client.cjs"
+    },
+    "./utils/mfe-port": {
+      import: "./dist/utils/mfe-port.js",
+      require: "./dist/utils/mfe-port.cjs"
     }
   },
   typesVersions: {
     "*": {
-      validation: [
-        "./dist/validation.d.ts"
-      ],
-      config: [
-        "./dist/config.d.ts"
-      ],
-      "config/client": [
-        "./dist/config/client.d.ts"
-      ],
-      "config/edge": [
-        "./dist/config/edge.d.ts"
-      ],
-      overrides: [
-        "./dist/overrides.d.ts"
-      ],
-      "next/config": [
-        "./dist/next/config.d.ts"
-      ],
-      "next/middleware": [
-        "./dist/next/middleware.d.ts"
-      ],
-      "next/endpoints": [
-        "./dist/next/endpoints.d.ts"
-      ],
-      "next/testing": [
-        "./dist/next/testing.d.ts"
-      ],
-      "v2/config": [
-        "./dist/v2/config.d.ts"
-      ],
-      "v2/microfrontends": [
-        "./dist/v2/microfrontends.d.ts"
-      ],
-      "v2/overrides": [
-        "./dist/v2/overrides.d.ts"
-      ],
-      "v2/microfrontends/server": [
-        "./dist/v2/microfrontends/server.d.ts"
-      ],
-      "v2/schema": [
-        "./dist/v2/schema.d.ts"
-      ],
-      "v2/next/config": [
-        "./dist/v2/next/config.d.ts"
-      ],
-      "v2/next/middleware": [
-        "./dist/v2/next/middleware.d.ts"
-      ],
-      "v2/next/endpoints": [
-        "./dist/v2/next/endpoints.d.ts"
-      ],
-      "next/client": [
-        "./dist/next/client.d.ts"
-      ],
-      "v2/next/client": [
-        "./dist/v2/next/client.d.ts"
-      ]
+      validation: ["./dist/validation.d.ts"],
+      config: ["./dist/config.d.ts"],
+      "config/client": ["./dist/config/client.d.ts"],
+      "config/edge": ["./dist/config/edge.d.ts"],
+      overrides: ["./dist/overrides.d.ts"],
+      "next/config": ["./dist/next/config.d.ts"],
+      "next/middleware": ["./dist/next/middleware.d.ts"],
+      "next/endpoints": ["./dist/next/endpoints.d.ts"],
+      "next/testing": ["./dist/next/testing.d.ts"],
+      "v2/config": ["./dist/v2/config.d.ts"],
+      "v2/microfrontends": ["./dist/v2/microfrontends.d.ts"],
+      "v2/overrides": ["./dist/v2/overrides.d.ts"],
+      "v2/microfrontends/server": ["./dist/v2/microfrontends/server.d.ts"],
+      "v2/schema": ["./dist/v2/schema.d.ts"],
+      "v2/next/config": ["./dist/v2/next/config.d.ts"],
+      "v2/next/middleware": ["./dist/v2/next/middleware.d.ts"],
+      "v2/next/endpoints": ["./dist/v2/next/endpoints.d.ts"],
+      "next/client": ["./dist/next/client.d.ts"],
+      "v2/next/client": ["./dist/v2/next/client.d.ts"],
+      "utils/mfe-port": ["./dist/utils/mfe-port.d.ts"]
     }
   },
-  files: [
-    "dist",
-    "schema"
-  ],
+  files: ["dist", "schema"],
   scripts: {
     build: "tsup",
     postbuild: "pnpm generate:exports",
@@ -223,7 +187,7 @@ var package_default = {
     "@vercel-private/conformance": "^1.12.2-canary.0",
     jest: "^29.7.0",
     "jest-environment-jsdom": "29.2.2",
-    next: "15.1.1-canary.0",
+    next: "15.1.1-canary.12",
     react: "19.0.0",
     "react-dom": "19.0.0",
     "ts-json-schema-generator": "^1.1.2",
@@ -233,7 +197,7 @@ var package_default = {
     webpack: "5"
   },
   peerDependencies: {
-    next: "15.1.1-canary.0",
+    next: "15.1.1-canary.12",
     react: "19.0.0",
     "react-dom": "19.0.0"
   },
@@ -1132,8 +1096,8 @@ function validateMainPath(applicationConfigsById) {
         });
       }
       for (const { id: otherId, paths } of pathsWithApp) {
-        const isValid = paths.every((path6) => {
-          const matcher = (0, import_path_to_regexp.pathToRegexp)(path6);
+        const isValid = paths.every((path7) => {
+          const matcher = (0, import_path_to_regexp.pathToRegexp)(path7);
           return !matcher.test(defaultRoute);
         });
         if (!isValid) {
@@ -1145,8 +1109,8 @@ function validateMainPath(applicationConfigsById) {
       }
     } else {
       const allPaths = app.routing.matches.flatMap((match) => match.paths);
-      const isValid = allPaths.some((path6) => {
-        const matcher = (0, import_path_to_regexp.pathToRegexp)(path6);
+      const isValid = allPaths.some((path7) => {
+        const matcher = (0, import_path_to_regexp.pathToRegexp)(path7);
         return matcher.test(defaultRoute);
       });
       if (!isValid) {
@@ -1166,18 +1130,18 @@ var validatePaths = (applicationConfigsById) => {
       continue;
     }
     for (const pathMatch of app.routing.matches) {
-      for (const path6 of pathMatch.paths) {
-        const maybeError = validatePathExpression(path6);
+      for (const path7 of pathMatch.paths) {
+        const maybeError = validatePathExpression(path7);
         if (maybeError) {
           errors.push(maybeError);
         }
-        const existing = pathsByApplicationId.get(path6);
+        const existing = pathsByApplicationId.get(path7);
         if (existing) {
           existing.applications.push(id);
         } else {
-          pathsByApplicationId.set(path6, {
+          pathsByApplicationId.set(path7, {
             applications: [id],
-            matcher: (0, import_path_to_regexp.pathToRegexp)(path6),
+            matcher: (0, import_path_to_regexp.pathToRegexp)(path7),
             applicationId: id
           });
         }
@@ -1185,10 +1149,10 @@ var validatePaths = (applicationConfigsById) => {
     }
   }
   const entries = Array.from(pathsByApplicationId.entries());
-  entries.forEach(([path6, { applications: ids, matcher, applicationId }]) => {
+  entries.forEach(([path7, { applications: ids, matcher, applicationId }]) => {
     if (ids.length > 1) {
       errors.push(
-        `Duplicate path "${path6}" for applications "${ids.join(", ")}"`
+        `Duplicate path "${path7}" for applications "${ids.join(", ")}"`
       );
     }
     entries.forEach(
@@ -1196,14 +1160,14 @@ var validatePaths = (applicationConfigsById) => {
         matchPath,
         { applications: matchIds, applicationId: matchApplicationId }
       ]) => {
-        if (path6 === matchPath) {
+        if (path7 === matchPath) {
           return;
         }
         if (applicationId === matchApplicationId) {
           return;
         }
         if (matcher.test(matchPath)) {
-          const source = `"${path6}" of application${ids.length > 0 ? "s" : ""} ${ids.join(", ")}`;
+          const source = `"${path7}" of application${ids.length > 0 ? "s" : ""} ${ids.join(", ")}`;
           const destination = `"${matchPath}" of application${matchIds.length > 0 ? "s" : ""} ${matchIds.join(", ")}`;
           errors.push(
             `Overlapping path detected between ${source} and ${destination}`
@@ -1220,25 +1184,25 @@ var validatePaths = (applicationConfigsById) => {
   }
 };
 var PATH_DEFAULT_PATTERN = "[^\\/#\\?]+?";
-function validatePathExpression(path6) {
-  const tokens = (0, import_path_to_regexp.parse)(path6);
+function validatePathExpression(path7) {
+  const tokens = (0, import_path_to_regexp.parse)(path7);
   for (let i = 0; i < tokens.length; i++) {
     const token = tokens[i];
     if (token === void 0) {
-      return `token ${i} in ${path6} is undefined, this shouldn't happen`;
+      return `token ${i} in ${path7} is undefined, this shouldn't happen`;
     }
     if (typeof token !== "string") {
       if (token.pattern !== PATH_DEFAULT_PATTERN) {
-        return `Path ${path6} cannot use a regular expression wildcard`;
+        return `Path ${path7} cannot use a regular expression wildcard`;
       }
       if (token.prefix !== "/") {
-        return `Wildcard :${token.name} must be immediately after a / in ${path6}`;
+        return `Wildcard :${token.name} must be immediately after a / in ${path7}`;
       }
       if (token.suffix) {
         return `Wildcard suffix on :${token.name} is not allowed. Suffixes are not supported`;
       }
       if (token.modifier && i !== tokens.length - 1) {
-        return `Modifier ${token.modifier} is not allowed on wildcard :${token.name} in ${path6}. Modifiers are only allowed in the last path component`;
+        return `Modifier ${token.modifier} is not allowed on wildcard :${token.name} in ${path7}. Modifiers are only allowed in the last path component`;
       }
     }
   }
@@ -1514,22 +1478,22 @@ var validateConfigPaths = (applicationConfigsById) => {
       continue;
     }
     for (const pathMatch of app.routing) {
-      for (const path6 of pathMatch.paths) {
-        const tokens = (0, import_path_to_regexp2.parse)(path6);
+      for (const path7 of pathMatch.paths) {
+        const tokens = (0, import_path_to_regexp2.parse)(path7);
         for (const token of tokens.slice(0, -1)) {
           if (typeof token !== "string") {
             errors.push(
-              `Path ${path6} may only have a :wildcard in the last path component`
+              `Path ${path7} may only have a :wildcard in the last path component`
             );
           }
         }
-        const existing = pathsByApplicationId.get(path6);
+        const existing = pathsByApplicationId.get(path7);
         if (existing) {
           existing.applications.push(id);
         } else {
-          pathsByApplicationId.set(path6, {
+          pathsByApplicationId.set(path7, {
             applications: [id],
-            matcher: (0, import_path_to_regexp2.pathToRegexp)(path6),
+            matcher: (0, import_path_to_regexp2.pathToRegexp)(path7),
             applicationId: id
           });
         }
@@ -1537,10 +1501,10 @@ var validateConfigPaths = (applicationConfigsById) => {
     }
   }
   const entries = Array.from(pathsByApplicationId.entries());
-  entries.forEach(([path6, { applications: ids, matcher, applicationId }]) => {
+  entries.forEach(([path7, { applications: ids, matcher, applicationId }]) => {
     if (ids.length > 1) {
       errors.push(
-        `Duplicate path "${path6}" for applications "${ids.join(", ")}"`
+        `Duplicate path "${path7}" for applications "${ids.join(", ")}"`
       );
     }
     entries.forEach(
@@ -1548,14 +1512,14 @@ var validateConfigPaths = (applicationConfigsById) => {
         matchPath,
         { applications: matchIds, applicationId: matchApplicationId }
       ]) => {
-        if (path6 === matchPath) {
+        if (path7 === matchPath) {
           return;
         }
         if (applicationId === matchApplicationId) {
           return;
         }
         if (matcher.test(matchPath)) {
-          const source = `"${path6}" of application${ids.length > 0 ? "s" : ""} ${ids.join(", ")}`;
+          const source = `"${path7}" of application${ids.length > 0 ? "s" : ""} ${ids.join(", ")}`;
           const destination = `"${matchPath}" of application${matchIds.length > 0 ? "s" : ""} ${matchIds.join(", ")}`;
           errors.push(
             `Overlapping path detected between ${source} and ${destination}`
@@ -1833,21 +1797,21 @@ var MicrofrontendConfigClient = class {
   isEqual(other) {
     return JSON.stringify(this.applications) === JSON.stringify(other.applications);
   }
-  getApplicationNameForPath(path6) {
-    if (!path6.startsWith("/")) {
+  getApplicationNameForPath(path7) {
+    if (!path7.startsWith("/")) {
       throw new Error(`Path must start with a /`);
     }
-    if (this.pathCache[path6]) {
-      return this.pathCache[path6];
+    if (this.pathCache[path7]) {
+      return this.pathCache[path7];
     }
-    const pathname = new URL(path6, "https://example.com").pathname;
+    const pathname = new URL(path7, "https://example.com").pathname;
     for (const [name, application] of Object.entries(this.applications)) {
       if (application.routing) {
         for (const group of application.routing) {
           for (const childPath of group.paths) {
             const regexp = (0, import_path_to_regexp3.pathToRegexp)(childPath);
             if (regexp.test(pathname)) {
-              this.pathCache[path6] = name;
+              this.pathCache[path7] = name;
               return name;
             }
           }
@@ -1860,7 +1824,7 @@ var MicrofrontendConfigClient = class {
     if (!defaultApplication) {
       return null;
     }
-    this.pathCache[path6] = defaultApplication[0];
+    this.pathCache[path7] = defaultApplication[0];
     return defaultApplication[0];
   }
   serialize() {
@@ -2959,7 +2923,7 @@ var LocalProxy = class {
     const isJWTRedirect = url.searchParams.has("_vercel_jwt");
     const defaultHost = this.getDefaultHost(config);
     let hostname = null;
-    let path6 = request2.url;
+    let path7 = request2.url;
     if (isAuthRedirect) {
       hostname = url.searchParams.get("_host_override");
     }
@@ -2969,12 +2933,12 @@ var LocalProxy = class {
     if (isJWTRedirect) {
       hostname = url.searchParams.get("_host_override");
       url.searchParams.delete("_host_override");
-      path6 = `${url.pathname}${url.search}`;
+      path7 = `${url.pathname}${url.search}`;
     }
     if (!hostname) {
       return void 0;
     }
-    return { ...defaultHost, path: path6, hostname, protocol: "https", port: 443 };
+    return { ...defaultHost, path: path7, hostname, protocol: "https", port: 443 };
   }
   getConfigWithOverrides(cookies) {
     if (isV2Config(this.config)) {
@@ -3005,19 +2969,19 @@ var LocalProxy = class {
   getTarget(request2) {
     const cookies = (0, import_cookie.parse)(request2.headers.cookie || "");
     const config = this.getConfigWithOverrides(cookies);
-    const path6 = request2.url;
-    if (!path6) {
+    const path7 = request2.url;
+    if (!path7) {
       return this.getDefaultHost(config);
     }
     const authTarget = this.getAuthTarget(request2, config);
     if (authTarget) {
       return authTarget;
     }
-    const url = new URL(`http://example.com${path6}`);
+    const url = new URL(`http://example.com${path7}`);
     const pathname = url.pathname;
     if (isV2Config(config)) {
       const target = this.findMatchingApplicationV2(
-        path6,
+        path7,
         pathname,
         config.getChildApplications()
       );
@@ -3025,7 +2989,7 @@ var LocalProxy = class {
         return target;
     } else {
       const target = this.findMatchingApplicationV1(
-        path6,
+        path7,
         pathname,
         config.getAllApplications()
       );
@@ -3034,11 +2998,11 @@ var LocalProxy = class {
     }
     const defaultHost = this.getDefaultHost(config);
     mfeDebug(
-      `no matching routes, routing ${path6} to default application: ${JSON.stringify(defaultHost)}`
+      `no matching routes, routing ${path7} to default application: ${JSON.stringify(defaultHost)}`
     );
-    return { path: path6, ...defaultHost };
+    return { path: path7, ...defaultHost };
   }
-  findMatchingApplicationV1(path6, pathname, applications) {
+  findMatchingApplicationV1(path7, pathname, applications) {
     for (const application of Object.values(applications)) {
       if (application.routing) {
         for (const group of application.routing.matches) {
@@ -3047,9 +3011,9 @@ var LocalProxy = class {
             if (regexp.test(pathname)) {
               const target = this.getApplicationTarget(application);
               mfeDebug(
-                `routing ${path6} to '${target.application}' at ${target.hostname}`
+                `routing ${path7} to '${target.application}' at ${target.hostname}`
               );
-              return { path: path6, ...target };
+              return { path: path7, ...target };
             }
           }
           if (application.routing.assetPrefix) {
@@ -3059,9 +3023,9 @@ var LocalProxy = class {
             if (pattern.test(pathname)) {
               const target = this.getApplicationTarget(application);
               mfeDebug(
-                `routing ${path6} to '${target.application}' at ${target.hostname}`
+                `routing ${path7} to '${target.application}' at ${target.hostname}`
               );
-              return { path: path6, ...target };
+              return { path: path7, ...target };
             }
           }
         }
@@ -3069,7 +3033,7 @@ var LocalProxy = class {
     }
     return null;
   }
-  findMatchingApplicationV2(path6, pathname, applications) {
+  findMatchingApplicationV2(path7, pathname, applications) {
     for (const application of Object.values(applications)) {
       for (const group of application.routing) {
         for (const childPath of group.paths) {
@@ -3077,9 +3041,9 @@ var LocalProxy = class {
           if (regexp.test(pathname)) {
             const target = this.getApplicationTarget(application);
             mfeDebug(
-              `routing ${path6} to '${target.application}' at ${target.hostname}`
+              `routing ${path7} to '${target.application}' at ${target.hostname}`
             );
-            return { path: path6, ...target };
+            return { path: path7, ...target };
           }
         }
       }
@@ -3088,11 +3052,11 @@ var LocalProxy = class {
   }
   // Handles requests that return data from the local proxy itself.
   // Returns true if the request was handled, false otherwise.
-  handleProxyInfoRequest(path6, res) {
-    if (!path6) {
+  handleProxyInfoRequest(path7, res) {
+    if (!path7) {
       return false;
     }
-    const url = new URL(`http://example.comf${path6}`);
+    const url = new URL(`http://example.comf${path7}`);
     const pathname = url.pathname;
     switch (pathname) {
       case "/.well-known/vercel/microfrontend-routing": {
@@ -3120,10 +3084,10 @@ var LocalProxy = class {
     }
     const target = this.getTarget(req);
     if (target.protocol === "https") {
-      const { hostname, port, path: path6 } = target;
+      const { hostname, port, path: path7 } = target;
       const requestOptions = {
         hostname,
-        path: path6,
+        path: path7,
         method: req.method,
         headers: {
           ...req.headers,
@@ -3151,7 +3115,7 @@ var LocalProxy = class {
         console.error("Proxy request error: ", err);
         res.writeHead(500, { "Content-Type": "text/plain" });
         res.end(
-          `Error proxying request for ${target.application} to ${hostname}:${port}${path6}`
+          `Error proxying request for ${target.application} to ${hostname}:${port}${path7}`
         );
       });
     } else {
@@ -3178,6 +3142,79 @@ var LocalProxy = class {
   }
 };
 
+// src/bin/port.ts
+var import_node_process = require("process");
+
+// src/utils/mfe-port.ts
+var import_node_path10 = __toESM(require("path"), 1);
+var import_node_fs9 = __toESM(require("fs"), 1);
+function mfePort(packageDir) {
+  const { name: appName, version } = getPackageJson(packageDir);
+  const result = loadV2({ packageDir, appName }) || loadV1({ packageDir, appName });
+  if (!result) {
+    throw new MicrofrontendError2(
+      `Unable to determine configured port for ${appName}`,
+      { type: "config", subtype: "not_found" }
+    );
+  }
+  const { port } = result;
+  return {
+    name: appName,
+    version,
+    port
+  };
+}
+function getPackageJson(packageDir) {
+  const filePath = import_node_path10.default.join(packageDir, "package.json");
+  return JSON.parse(import_node_fs9.default.readFileSync(filePath, "utf-8"));
+}
+function loadV2({
+  packageDir,
+  appName
+}) {
+  let config;
+  try {
+    config = MicrofrontendsServer.infer({
+      directory: packageDir,
+      meta: { fromApp: appName },
+      options: { resolveMainConfig: true }
+    });
+  } catch (e) {
+    return void 0;
+  }
+  const app = config.config.getApplication(appName);
+  const port = app.development.local.port;
+  return { port };
+}
+function loadV1({
+  packageDir,
+  appName
+}) {
+  const filePath = import_node_path10.default.join(packageDir, "micro-frontends.jsonc");
+  let config;
+  try {
+    config = MicrofrontendConfig.fromFile({ filePath });
+  } catch (e) {
+    return void 0;
+  }
+  const zone = config.getZone(appName);
+  const port = zone.development.local.port;
+  return { port };
+}
+
+// src/bin/port.ts
+function displayPort() {
+  const portInfo = mfePort((0, import_node_process.cwd)());
+  header(portInfo);
+  console.log(portInfo.port);
+}
+function header({ name, version, port }) {
+  console.error(`
+  \u25B2 ${name}@${version}
+    \xB7 setting port to ${port}
+  `);
+}
+
 // src/bin/index.ts
 function main() {
   const program = new import_commander.Command();
@@ -3195,6 +3232,9 @@ function main() {
     });
     localProxy.startServer();
   });
+  program.command("port").description("Prints development port").action(() => {
+    displayPort();
+  });
   program.parse(process.argv);
 }
 main();