@vercel/microfrontends 0.13.0 → 0.14.0

package/README.md

@@ -123,7 +123,7 @@ export async function middleware(
   request: NextRequest,
   event: NextFetchEvent,
 ): Promise<Response> {
-  let response = await runMicrofrontendsMiddleware(request);
+  let response = await runMicrofrontendsMiddleware({ request });
   if (response) {
     return response;
   }
@@ -136,7 +136,7 @@ The Micro-Frontends features rely on information exposed in two `.well-known`
 endpoints:
 
 - `/.well-known/vercel/micro-frontends/server-config`
-- `/.well-known/vercel/micro-frontends/client-config`
+- `/.well-known/vercel/microfrontends/client-config`
 
 You must define API handlers for these two routes to serve the information to
 the client and Vercel Toolbar for Micro-Frontends features to work.
@@ -148,7 +148,7 @@ file:
 export { wellKnownNextjsServerConfigAppRoute as GET } from '@vercel/microfrontends/next/endpoints';
 ```
 
-Then do the same for `app/.well-known/vercel/micro-frontends/client-config/route.ts`:
+Then do the same for `app/.well-known/vercel/microfrontends/client-config/route.ts`:
 
 ```typescript filename
 export { wellKnownNextjsClientConfigAppRoute as GET } from '@vercel/microfrontends/next/endpoints';

package/dist/bin/cli.cjs

@@ -29,7 +29,7 @@ var import_commander = require("commander");
 // package.json
 var package_default = {
   name: "@vercel/microfrontends",
-  version: "0.13.0",
+  version: "0.14.0",
   private: false,
   description: "Defines configuration and utilities for micro-frontend development",
   repository: {
@@ -40,6 +40,7 @@ var package_default = {
   sideEffects: false,
   type: "module",
   bin: {
+    microfrontends: "./cli/index.cjs",
     "micro-frontends": "./cli/index.cjs"
   },
   exports: {
@@ -92,6 +93,10 @@ var package_default = {
       import: "./dist/v2/overrides.js",
       require: "./dist/v2/overrides.cjs"
     },
+    "./v2/routing": {
+      import: "./dist/v2/routing.js",
+      require: "./dist/v2/routing.cjs"
+    },
     "./v2/microfrontends/server": {
       import: "./dist/v2/microfrontends/server.js",
       require: "./dist/v2/microfrontends/server.cjs"
@@ -112,6 +117,10 @@ var package_default = {
       import: "./dist/v2/next/endpoints.js",
       require: "./dist/v2/next/endpoints.cjs"
     },
+    "./v2/next/testing": {
+      import: "./dist/v2/next/testing.js",
+      require: "./dist/v2/next/testing.cjs"
+    },
     "./next/client": {
       import: "./dist/next/client.js",
       require: "./dist/next/client.cjs"
@@ -139,11 +148,13 @@ var package_default = {
       "v2/config": ["./dist/v2/config.d.ts"],
       "v2/microfrontends": ["./dist/v2/microfrontends.d.ts"],
       "v2/overrides": ["./dist/v2/overrides.d.ts"],
+      "v2/routing": ["./dist/v2/routing.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"],
+      "v2/next/testing": ["./dist/v2/next/testing.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"]
@@ -187,7 +198,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.12",
+    next: "15.2.0-canary.14",
     react: "19.0.0",
     "react-dom": "19.0.0",
     "ts-json-schema-generator": "^1.1.2",
@@ -197,7 +208,7 @@ var package_default = {
     webpack: "5"
   },
   peerDependencies: {
-    next: "15.1.1-canary.12",
+    next: "15.2.0-canary.14",
     react: "19.0.0",
     "react-dom": "19.0.0"
   },
@@ -1582,19 +1593,6 @@ var validateConfigDefaultApplication = (applicationConfigsById) => {
     );
   }
 };
-var validateConfigOptions = (options) => {
-  var _a;
-  if ((_a = options == null ? void 0 : options.vercel) == null ? void 0 : _a.previewDeploymentSuffix) {
-    if (!/^[a-zA-Z]{2,}\.[a-zA-Z]{2,}$/.test(
-      options.vercel.previewDeploymentSuffix
-    )) {
-      throw new MicrofrontendError2(
-        `Invalid preview deployment suffix: ${options.vercel.previewDeploymentSuffix}. Should have be formatted like "vercel.app".`,
-        { type: "config", subtype: "invalid_preview_deployment_suffix" }
-      );
-    }
-  }
-};
 
 // src/config-v2/microfrontends-config/isomorphic/utils/generate-asset-prefix.ts
 var PREFIX = "vc-ap";
@@ -1933,7 +1931,6 @@ var MicrofrontendConfigIsomorphic = class {
       validateConfigPaths(c.applications);
       validateConfigDefaultApplication(c.applications);
     }
-    validateConfigOptions(c.options);
     return c;
   }
   static fromEnv({
@@ -2097,8 +2094,8 @@ function isMainConfig2(c) {
 }
 
 // src/config-v2/microfrontends/server/index.ts
-var import_node_fs8 = __toESM(require("fs"), 1);
-var import_node_path9 = require("path");
+var import_node_fs9 = __toESM(require("fs"), 1);
+var import_node_path10 = require("path");
 
 // src/config-v2/microfrontends-config/isomorphic/child.ts
 var MicrofrontendChildConfig = class extends MicrofrontendConfigIsomorphic {
@@ -2218,29 +2215,39 @@ function findPackagePath(opts) {
 // src/config-v2/microfrontends/utils/find-default-package.ts
 var import_node_path6 = require("path");
 var import_node_fs5 = require("fs");
+var import_jsonc_parser3 = require("jsonc-parser");
 var import_fast_glob2 = __toESM(require("fast-glob"), 1);
+
+// src/config-v2/constants.ts
+var CONFIGURATION_FILENAMES = [
+  "microfrontends.jsonc",
+  "microfrontends.json"
+];
+
+// src/config-v2/microfrontends/utils/find-default-package.ts
 var configCache2 = {};
 function findDefaultMicrofrontendsPackages({
   repositoryRoot,
   applicationName
 }) {
   try {
-    const microfrontendsJsonPaths = import_fast_glob2.default.globSync("**/microfrontends.json", {
-      cwd: repositoryRoot,
-      absolute: true,
-      onlyFiles: true,
-      followSymbolicLinks: false,
-      ignore: ["**/node_modules/**", "**/.git/**"]
-    });
+    const microfrontendsJsonPaths = import_fast_glob2.default.globSync(
+      `**/{${CONFIGURATION_FILENAMES.join(",")}}`,
+      {
+        cwd: repositoryRoot,
+        absolute: true,
+        onlyFiles: true,
+        followSymbolicLinks: false,
+        ignore: ["**/node_modules/**", "**/.git/**"]
+      }
+    );
     const matchingPaths = [];
     for (const microfrontendsJsonPath of microfrontendsJsonPaths) {
       const microfrontendsJsonContent = (0, import_node_fs5.readFileSync)(
         microfrontendsJsonPath,
         "utf-8"
       );
-      const microfrontendsJson = JSON.parse(
-        microfrontendsJsonContent
-      );
+      const microfrontendsJson = (0, import_jsonc_parser3.parse)(microfrontendsJsonContent);
       if (isMainConfig(microfrontendsJson) && microfrontendsJson.applications[applicationName]) {
         matchingPaths.push(microfrontendsJsonPath);
       }
@@ -2270,7 +2277,7 @@ function findDefaultMicrofrontendsPackage(opts) {
   const result = findDefaultMicrofrontendsPackages(opts);
   if (!result) {
     throw new Error(
-      `Error trying to resolve the main microfrontends.json configuration`
+      `Error trying to resolve the main microfrontends configuration`
     );
   }
   configCache2[cacheKey] = result;
@@ -2322,8 +2329,21 @@ function findPackageRoot(startDir) {
   );
 }
 
+// src/config-v2/microfrontends/utils/find-config.ts
+var import_node_fs8 = __toESM(require("fs"), 1);
+var import_node_path9 = require("path");
+function findConfig({ dir }) {
+  for (const filename of CONFIGURATION_FILENAMES) {
+    const maybeConfig = (0, import_node_path9.join)(dir, filename);
+    if (import_node_fs8.default.existsSync(maybeConfig)) {
+      return maybeConfig;
+    }
+  }
+  return null;
+}
+
 // src/config-v2/microfrontends/server/validation.ts
-var import_jsonc_parser3 = require("jsonc-parser");
+var import_jsonc_parser4 = require("jsonc-parser");
 var import_ajv2 = require("ajv");
 
 // schema/schema-v2.json
@@ -2384,10 +2404,6 @@ var schema_v2_default = {
     VercelOptions: {
       type: "object",
       properties: {
-        previewDeploymentSuffix: {
-          type: "string",
-          description: "If your team uses a custom Preview Deployment Suffix, please specify it here. See https://vercel.com/docs/deployments/preview-deployment-suffix. The default is `vercel.app`."
-        },
         teamSlug: {
           type: "string",
           description: "Team slug for the Vercel team"
@@ -2581,7 +2597,7 @@ var SCHEMA2 = schema_v2_default;
 
 // src/config-v2/microfrontends/server/validation.ts
 function validateSchema2(configString) {
-  const parsedConfig = (0, import_jsonc_parser3.parse)(configString);
+  const parsedConfig = (0, import_jsonc_parser4.parse)(configString);
   const ajv = new import_ajv2.Ajv();
   const validate = ajv.compile(SCHEMA2);
   const isValid = validate(parsedConfig);
@@ -2603,8 +2619,8 @@ var MicrofrontendsServer = class extends Microfrontends {
     pretty: true
   }) {
     const outputPath = getOutputFilePath();
-    import_node_fs8.default.mkdirSync((0, import_node_path9.dirname)(outputPath), { recursive: true });
-    import_node_fs8.default.writeFileSync(
+    import_node_fs9.default.mkdirSync((0, import_node_path10.dirname)(outputPath), { recursive: true });
+    import_node_fs9.default.writeFileSync(
       outputPath,
       JSON.stringify(
         this.config.toSchemaJson(),
@@ -2667,8 +2683,8 @@ var MicrofrontendsServer = class extends Microfrontends {
     return config;
   }
   /**
-   * Looks up the configuration by inferring the package root and looking for a microfrontends.json file. If a file is not found,
-   * it will look for a package in the repository with a microfrontends.json file that contains the current application
+   * Looks up the configuration by inferring the package root and looking for a microfrontends config file. If a file is not found,
+   * it will look for a package in the repository with a microfrontends file that contains the current application
    * and use that configuration.
    *
    * This can return either a Child or Main configuration.
@@ -2690,16 +2706,16 @@ var MicrofrontendsServer = class extends Microfrontends {
     }
     try {
       const packageRoot = findPackageRoot(directory);
-      const packageJsonPath = (0, import_node_path9.join)(packageRoot, "package.json");
+      const packageJsonPath = (0, import_node_path10.join)(packageRoot, "package.json");
       const packageJson = JSON.parse(
-        import_node_fs8.default.readFileSync(packageJsonPath, "utf-8")
+        import_node_fs9.default.readFileSync(packageJsonPath, "utf-8")
       );
       if (!packageJson.name) {
         throw new Error(`No name found in package.json at ${packageJsonPath}`);
       }
       const configMeta = meta ?? { fromApp: packageJson.name };
-      const maybeConfig = (0, import_node_path9.join)(packageRoot, "microfrontends.json");
-      if (import_node_fs8.default.existsSync(maybeConfig)) {
+      const maybeConfig = findConfig({ dir: packageRoot });
+      if (maybeConfig) {
         return MicrofrontendsServer.fromFile({
           filePath: maybeConfig,
           cookies,
@@ -2714,12 +2730,15 @@ var MicrofrontendsServer = class extends Microfrontends {
           repositoryRoot,
           applicationName: packageJson.name
         });
-        return MicrofrontendsServer.fromFile({
-          filePath: (0, import_node_path9.join)(defaultPackage, "microfrontends.json"),
-          cookies,
-          meta: configMeta,
-          options
-        });
+        const maybeConfigFromDefault = findConfig({ dir: defaultPackage });
+        if (maybeConfigFromDefault) {
+          return MicrofrontendsServer.fromFile({
+            filePath: maybeConfigFromDefault,
+            cookies,
+            meta: configMeta,
+            options
+          });
+        }
       }
       throw new Error("Unable to infer");
     } catch (e) {
@@ -2739,7 +2758,7 @@ var MicrofrontendsServer = class extends Microfrontends {
     options
   }) {
     try {
-      const configJson = import_node_fs8.default.readFileSync(filePath, "utf-8");
+      const configJson = import_node_fs9.default.readFileSync(filePath, "utf-8");
       const config = MicrofrontendsServer.validate(configJson);
       if (!isMainConfig(config) && (options == null ? void 0 : options.resolveMainConfig)) {
         const repositoryRoot = findRepositoryRoot();
@@ -2755,9 +2774,15 @@ var MicrofrontendsServer = class extends Microfrontends {
               { type: "config", subtype: "not_found" }
             );
           }
-          const mainConfigPath = (0, import_node_path9.join)(packagePath, "microfrontends.json");
+          const maybeConfig = findConfig({ dir: packagePath });
+          if (!maybeConfig) {
+            throw new MicrofrontendError2(
+              `Could not find microfrontends configuration in ${packagePath}`,
+              { type: "config", subtype: "not_found" }
+            );
+          }
           return MicrofrontendsServer.fromMainConfigFile({
-            filePath: mainConfigPath,
+            filePath: maybeConfig,
             overrides: cookies ? parseOverrides(cookies) : void 0
           });
         }
@@ -2781,7 +2806,7 @@ var MicrofrontendsServer = class extends Microfrontends {
     overrides
   }) {
     try {
-      const config = import_node_fs8.default.readFileSync(filePath, "utf-8");
+      const config = import_node_fs9.default.readFileSync(filePath, "utf-8");
       const validatedConfig = MicrofrontendsServer.validate(config);
       if (!isMainConfig(validatedConfig)) {
         throw new MicrofrontendError2(
@@ -3059,7 +3084,7 @@ var LocalProxy = class {
     const url = new URL(`http://example.comf${path7}`);
     const pathname = url.pathname;
     switch (pathname) {
-      case "/.well-known/vercel/microfrontend-routing": {
+      case "/.well-known/vercel/microfrontends/routing": {
         res.writeHead(200, {
           "Content-Type": "application/json"
         });
@@ -3146,8 +3171,8 @@ var LocalProxy = class {
 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);
+var import_node_path11 = __toESM(require("path"), 1);
+var import_node_fs10 = __toESM(require("fs"), 1);
 function mfePort(packageDir) {
   const { name: appName, version } = getPackageJson(packageDir);
   const result = loadV2({ packageDir, appName }) || loadV1({ packageDir, appName });
@@ -3165,8 +3190,8 @@ function mfePort(packageDir) {
   };
 }
 function getPackageJson(packageDir) {
-  const filePath = import_node_path10.default.join(packageDir, "package.json");
-  return JSON.parse(import_node_fs9.default.readFileSync(filePath, "utf-8"));
+  const filePath = import_node_path11.default.join(packageDir, "package.json");
+  return JSON.parse(import_node_fs10.default.readFileSync(filePath, "utf-8"));
 }
 function loadV2({
   packageDir,
@@ -3190,7 +3215,7 @@ function loadV1({
   packageDir,
   appName
 }) {
-  const filePath = import_node_path10.default.join(packageDir, "micro-frontends.jsonc");
+  const filePath = import_node_path11.default.join(packageDir, "micro-frontends.jsonc");
   let config;
   try {
     config = MicrofrontendConfig.fromFile({ filePath });

package/dist/config/client.d.ts

@@ -5,7 +5,7 @@ interface ClientConfig {
     applications: Record<string, ClientApplicationConfig>;
 }
 /**
- * Data that is returned from the `.well-known/vercel/micro-frontends/client-config`
+ * Data that is returned from the `.well-known/vercel/microfrontends/client-config`
  * endpoint that is used by the client to ensure that navigations and prefetches
  * are routed correctly.
  */