@vercel/microfrontends 1.2.0 → 1.2.1

package/dist/next/config.d.ts

@@ -20,8 +20,22 @@ interface WithMicrofrontendsOptions {
 }
 
 /**
- * A function that wraps the next.config.js file to automatically configure zones
- * based on the microfrontends configuration.
+ * Automatically configures your Next.js application to work with microfrontends.
+ *
+ * This function should wrap your Next.js config object before it is exported. It
+ * will automatically set up the necessary fields and environment variables for
+ * microfrontends to work.
+ *
+ * See the [Getting Started](https://vercel.com/docs/microfrontends/quickstart) guide for more information.
+ *
+ * @example Wrapping your Next.js config
+ * ```js
+ * import { withMicrofrontends } from '@vercel/microfrontends/next/config';
+ *
+ * const nextConfig = { ... };
+ *
+ * export default withMicrofrontends(nextConfig);
+ * ```
  */
 declare function withMicrofrontends(nextConfig: NextConfig, opts?: WithMicrofrontendsOptions): NextConfig;
 

package/dist/next/config.js

@@ -176,11 +176,11 @@ function findRepositoryRoot(startDir) {
     currentDir = path.dirname(currentDir);
   }
   throw new Error(
-    "Repository root not found. Specify the root of the repository with the `repository.root` option."
+    `Could not find the root of the repository for ${startDir}. Please ensure that the directory is part of a Git repository. If you suspect that this should work, please file an issue to the Vercel team.`
   );
 }
 
-// src/config/microfrontends/utils/find-default-package.ts
+// src/config/microfrontends/utils/infer-microfrontends-location.ts
 import { dirname } from "node:path";
 import { readFileSync } from "node:fs";
 import { parse } from "jsonc-parser";
@@ -192,9 +192,9 @@ var CONFIGURATION_FILENAMES = [
   "microfrontends.json"
 ];
 
-// src/config/microfrontends/utils/find-default-package.ts
+// src/config/microfrontends/utils/infer-microfrontends-location.ts
 var configCache = {};
-function findDefaultMicrofrontendsPackages({
+function findPackageWithMicrofrontendsConfig({
   repositoryRoot,
   applicationName
 }) {
@@ -225,13 +225,13 @@ function findDefaultMicrofrontendsPackages({
     }
     if (matchingPaths.length > 1) {
       throw new Error(
-        `Found multiple default applications referencing "${applicationName}" in the repository, but only one is allowed.
+        `Found multiple \`microfrontends.json\` files in the repository referencing the application "${applicationName}", but only one is allowed.
 ${matchingPaths.join("\n  \u2022 ")}`
       );
     }
     if (matchingPaths.length === 0) {
       throw new Error(
-        `Could not find default application with "applications.${applicationName}"`
+        `Could not find a \`microfrontends.json\` file in the repository that contains "applications.${applicationName}". Microfrontends defined in separate repositories are not supported yet.`
       );
     }
     const [packageJsonPath] = matchingPaths;
@@ -240,15 +240,15 @@ ${matchingPaths.join("\n  \u2022 ")}`
     return null;
   }
 }
-function findDefaultMicrofrontendsPackage(opts) {
+function inferMicrofrontendsLocation(opts) {
   const cacheKey = `${opts.repositoryRoot}-${opts.applicationName}`;
   if (configCache[cacheKey]) {
     return configCache[cacheKey];
   }
-  const result = findDefaultMicrofrontendsPackages(opts);
+  const result = findPackageWithMicrofrontendsConfig(opts);
   if (!result) {
     throw new Error(
-      "Error trying to resolve the main microfrontends configuration"
+      `Could not infer the location of the \`microfrontends.json\` file for application "${opts.applicationName}" starting in directory "${opts.repositoryRoot}".`
     );
   }
   configCache[cacheKey] = result;
@@ -299,7 +299,7 @@ function findPackageRoot(startDir) {
     currentDir = path3.dirname(currentDir);
   }
   throw new Error(
-    "Package root not found. Specify the root of the package with the `package.root` option."
+    `The root of the package that contains the \`package.json\` file for the \`${startDir}\` directory could not be found.`
   );
 }
 
@@ -340,7 +340,9 @@ var MicrofrontendConfigClient = class {
    */
   static fromEnv(config, opts) {
     if (!config) {
-      throw new Error("No microfrontends configuration found");
+      throw new Error(
+        "Could not construct MicrofrontendConfigClient: configuration is empty or undefined. Did you set up your application with `withMicrofrontends`?"
+      );
     }
     return new MicrofrontendConfigClient(
       JSON.parse(config),
@@ -1362,7 +1364,7 @@ var MicrofrontendsServer = class {
       const repositoryRoot = findRepositoryRoot();
       const isMonorepo2 = isMonorepo({ repositoryRoot });
       if (isMonorepo2) {
-        const defaultPackage = findDefaultMicrofrontendsPackage({
+        const defaultPackage = inferMicrofrontendsLocation({
           repositoryRoot,
           applicationName: appName
         });
@@ -1374,13 +1376,15 @@ var MicrofrontendsServer = class {
           });
         }
       }
-      throw new Error("Unable to infer");
+      throw new Error(
+        "Unable to automatically infer the location of the `microfrontends.json` file. Microfrontends defined in separate repositories are not supported yet. If you suspect this is thrown in error, please reach out to the Vercel team."
+      );
     } catch (e) {
       if (e instanceof MicrofrontendError) {
         throw e;
       }
       throw new MicrofrontendError(
-        "Unable to locate and parse microfrontends configuration",
+        "Unable to locate and parse the `microfrontends.json` configuration file.",
         { cause: e, type: "config", subtype: "inference_failed" }
       );
     }