@vercel/microfrontends 0.9.0 → 0.10.0

package/dist/v2/microfrontends/server.cjs

@@ -71,14 +71,14 @@ function parseOverrides(cookies) {
 }
 
 // src/config-v2/errors.ts
-var MicroFrontendError = class extends Error {
+var MicrofrontendError = class extends Error {
   constructor(message, opts) {
     super(message);
-    this.name = "MicroFrontendsError";
-    this.source = (opts == null ? void 0 : opts.source) ?? "@vercel/micro-frontends";
+    this.name = "MicrofrontendsError";
+    this.source = (opts == null ? void 0 : opts.source) ?? "@vercel/microfrontends";
     this.type = (opts == null ? void 0 : opts.type) ?? "unknown";
     this.subtype = opts == null ? void 0 : opts.subtype;
-    Error.captureStackTrace(this, MicroFrontendError);
+    Error.captureStackTrace(this, MicrofrontendError);
   }
   isKnown() {
     return this.type !== "unknown";
@@ -87,13 +87,13 @@ var MicroFrontendError = class extends Error {
     return !this.isKnown();
   }
   /**
-   * Converts an error to a MicroFrontendsError.
+   * Converts an error to a MicrofrontendsError.
    * @param original - The original error to convert.
-   * @returns The converted MicroFrontendsError.
+   * @returns The converted MicrofrontendsError.
    */
   static convert(original, opts) {
     if (opts == null ? void 0 : opts.fileName) {
-      const err = MicroFrontendError.convertFSError(original, opts.fileName);
+      const err = MicrofrontendError.convertFSError(original, opts.fileName);
       if (err) {
         return err;
       }
@@ -101,25 +101,25 @@ var MicroFrontendError = class extends Error {
     if (original.message.includes(
       "Code generation from strings disallowed for this context"
     )) {
-      return new MicroFrontendError(original.message, {
+      return new MicrofrontendError(original.message, {
         type: "config",
         subtype: "unsupported_validation_env",
         source: "ajv"
       });
     }
-    return new MicroFrontendError(original.message);
+    return new MicrofrontendError(original.message);
   }
   static convertFSError(original, fileName) {
     if (original instanceof Error && "code" in original) {
       if (original.code === "ENOENT") {
-        return new MicroFrontendError(`Could not find "${fileName}"`, {
+        return new MicrofrontendError(`Could not find "${fileName}"`, {
           type: "config",
           subtype: "unable_to_read_file",
           source: "fs"
         });
       }
       if (original.code === "EACCES") {
-        return new MicroFrontendError(
+        return new MicrofrontendError(
           `Permission denied while accessing "${fileName}"`,
           {
             type: "config",
@@ -130,7 +130,7 @@ var MicroFrontendError = class extends Error {
       }
     }
     if (original instanceof SyntaxError) {
-      return new MicroFrontendError(
+      return new MicrofrontendError(
         `Failed to parse "${fileName}": Invalid JSON format.`,
         {
           type: "config",
@@ -142,23 +142,23 @@ var MicroFrontendError = class extends Error {
     return null;
   }
   /**
-   * Handles an unknown error and returns a MicroFrontendsError instance.
+   * Handles an unknown error and returns a MicrofrontendsError instance.
    * @param err - The error to handle.
-   * @returns A MicroFrontendsError instance.
+   * @returns A MicrofrontendsError instance.
    */
   static handle(err, opts) {
-    if (err instanceof MicroFrontendError) {
+    if (err instanceof MicrofrontendError) {
       return err;
     }
     if (err instanceof Error) {
-      return MicroFrontendError.convert(err, opts);
+      return MicrofrontendError.convert(err, opts);
     }
     if (typeof err === "object" && err !== null) {
       if ("message" in err && typeof err.message === "string") {
-        return MicroFrontendError.convert(new Error(err.message), opts);
+        return MicrofrontendError.convert(new Error(err.message), opts);
       }
     }
-    return new MicroFrontendError("An unknown error occurred");
+    return new MicrofrontendError("An unknown error occurred");
   }
 };
 
@@ -166,7 +166,7 @@ var MicroFrontendError = class extends Error {
 function getConfigStringFromEnv() {
   const config = process.env.MFE_CONFIG;
   if (!config) {
-    throw new MicroFrontendError(`Missing "MFE_CONFIG" in environment.`, {
+    throw new MicrofrontendError(`Missing "MFE_CONFIG" in environment.`, {
       type: "config",
       subtype: "not_found_in_env"
     });
@@ -189,7 +189,7 @@ function isDefaultApp(a) {
 
 // src/config-v2/microfrontends-config/client/index.ts
 var import_path_to_regexp = require("path-to-regexp");
-var MicroFrontendConfigClient = class {
+var MicrofrontendConfigClient = class {
   constructor(config, opts) {
     this.pathCache = {};
     this.serialized = config;
@@ -203,14 +203,14 @@ var MicroFrontendConfigClient = class {
     this.applications = config.applications;
   }
   /**
-   * Create a new `MicroFrontendConfigClient` from a JSON string.
+   * Create a new `MicrofrontendConfigClient` from a JSON string.
    * Config must be passed in to remain framework agnostic
    */
   static fromEnv(config, opts) {
     if (!config) {
-      throw new Error("No micro-frontends configuration found");
+      throw new Error("No microfrontends configuration found");
     }
-    return new MicroFrontendConfigClient(
+    return new MicrofrontendConfigClient(
       JSON.parse(config),
       opts
     );
@@ -258,7 +258,7 @@ var import_path_to_regexp2 = require("path-to-regexp");
 var SUPPORTED_VERSIONS = ["2"];
 var validateConfigVersion = (version) => {
   if (!SUPPORTED_VERSIONS.includes(version)) {
-    throw new MicroFrontendError(
+    throw new MicrofrontendError(
       `Unsupported version: ${version}. Supported versions are: ${SUPPORTED_VERSIONS.join(
         ", "
       )}`,
@@ -328,7 +328,7 @@ var validateConfigPaths = (applicationConfigsById) => {
     );
   });
   if (errors.length) {
-    throw new MicroFrontendError(`Invalid paths: ${errors.join(", ")}`, {
+    throw new MicrofrontendError(`Invalid paths: ${errors.join(", ")}`, {
       type: "config",
       subtype: "conflicting_paths"
     });
@@ -341,13 +341,13 @@ var validateAppPaths = (name, app) => {
         continue;
       }
       if (p.endsWith("/")) {
-        throw new MicroFrontendError(
+        throw new MicrofrontendError(
           `Invalid path for application "${name}". ${p} must not end with a slash.`,
           { type: "application", subtype: "invalid_path" }
         );
       }
       if (!p.startsWith("/")) {
-        throw new MicroFrontendError(
+        throw new MicrofrontendError(
           `Invalid path for application "${name}". ${p} must start with a slash.`,
           { type: "application", subtype: "invalid_path" }
         );
@@ -369,13 +369,13 @@ var validateConfigDefaultApplication = (applicationConfigsById) => {
   const numApplicationsWithRouting = applicationsWithRoutingNames.length;
   const numApplicationsWithoutRouting = numApplications - numApplicationsWithRouting;
   if (numApplicationsWithoutRouting === 0) {
-    throw new MicroFrontendError(
+    throw new MicrofrontendError(
       `No default application found. At least one application needs to be the default by omitting routing.`,
       { type: "config", subtype: "no_default_application" }
     );
   }
   if (numApplicationsWithoutRouting > 1) {
-    throw new MicroFrontendError(
+    throw new MicrofrontendError(
       `Only one application can omit "routing". Found ${applicationsWithRoutingNames.length - Object.keys(applicationConfigsById).length > 1}.`,
       { type: "config", subtype: "multiple_default_applications" }
     );
@@ -387,7 +387,7 @@ var validateConfigOptions = (options) => {
     if (!/^[a-zA-Z]{2,}\.[a-zA-Z]{2,}$/.test(
       options.vercel.previewDeploymentSuffix
     )) {
-      throw new MicroFrontendError(
+      throw new MicrofrontendError(
         `Invalid preview deployment suffix: ${options.vercel.previewDeploymentSuffix}. Should have be formatted like "vercel.app".`,
         { type: "config", subtype: "invalid_preview_deployment_suffix" }
       );
@@ -546,7 +546,7 @@ var ChildApplication = class extends Application {
 var DEFAULT_LOCAL_PROXY_PORT = 3024;
 
 // src/config-v2/microfrontends-config/isomorphic/index.ts
-var MicroFrontendConfigIsomorphic = class {
+var MicrofrontendConfigIsomorphic = class {
   constructor({
     config,
     overrides,
@@ -554,7 +554,7 @@ var MicroFrontendConfigIsomorphic = class {
   }) {
     this.childApplications = {};
     var _a, _b, _c, _d;
-    MicroFrontendConfigIsomorphic.validate(config);
+    MicrofrontendConfigIsomorphic.validate(config);
     const disableOverrides = ((_b = (_a = config.options) == null ? void 0 : _a.vercel) == null ? void 0 : _b.disableOverrides) ?? false;
     this.overrides = overrides && !disableOverrides ? overrides : void 0;
     this.isMainConfig = isMainConfig(config);
@@ -586,7 +586,7 @@ var MicroFrontendConfigIsomorphic = class {
       );
     }
     if (isMainConfig(config) && !this.defaultApplication) {
-      throw new MicroFrontendError(
+      throw new MicrofrontendError(
         `Could not find default application in microfrontends configuration`,
         {
           type: "application",
@@ -616,7 +616,7 @@ var MicroFrontendConfigIsomorphic = class {
     meta,
     cookies
   }) {
-    return new MicroFrontendConfigIsomorphic({
+    return new MicrofrontendConfigIsomorphic({
       config: (0, import_jsonc_parser.parse)(getConfigStringFromEnv()),
       overrides: parseOverrides(cookies ?? []),
       meta
@@ -651,7 +651,7 @@ var MicroFrontendConfigIsomorphic = class {
     }
     const app = this.childApplications[name];
     if (!app) {
-      throw new MicroFrontendError(
+      throw new MicrofrontendError(
         `Could not find microfrontends configuration for application "${name}"`,
         {
           type: "application",
@@ -679,7 +679,7 @@ var MicroFrontendConfigIsomorphic = class {
    */
   getDefaultApplication() {
     if (!this.defaultApplication) {
-      throw new MicroFrontendError(
+      throw new MicrofrontendError(
         `Could not find default application in microfrontends configuration`,
         {
           type: "application",
@@ -719,7 +719,7 @@ var MicroFrontendConfigIsomorphic = class {
         default: true
       };
     }
-    return new MicroFrontendConfigClient({
+    return new MicrofrontendConfigClient({
       applications
     });
   }
@@ -729,7 +729,7 @@ var MicroFrontendConfigIsomorphic = class {
 };
 
 // src/config-v2/microfrontends-config/isomorphic/child.ts
-var MicroFrontendChildConfig = class extends MicroFrontendConfigIsomorphic {
+var MicrofrontendChildConfig = class extends MicrofrontendConfigIsomorphic {
   constructor({
     config,
     overrides,
@@ -742,7 +742,7 @@ var MicroFrontendChildConfig = class extends MicroFrontendConfigIsomorphic {
 };
 
 // src/config-v2/microfrontends-config/isomorphic/main.ts
-var MicroFrontendMainConfig = class extends MicroFrontendConfigIsomorphic {
+var MicrofrontendMainConfig = class extends MicrofrontendConfigIsomorphic {
   constructor({
     config,
     overrides,
@@ -769,7 +769,7 @@ var MicroFrontendMainConfig = class extends MicroFrontendConfigIsomorphic {
       }
     }
     if (!defaultApplication) {
-      throw new MicroFrontendError(
+      throw new MicrofrontendError(
         `Could not find default application in microfrontends configuration`,
         {
           type: "application",
@@ -789,19 +789,19 @@ var Microfrontends = class {
     meta
   }) {
     if (isMainConfig(config)) {
-      this.config = new MicroFrontendMainConfig({ config, overrides, meta });
+      this.config = new MicrofrontendMainConfig({ config, overrides, meta });
     } else {
-      this.config = new MicroFrontendChildConfig({ config, overrides, meta });
+      this.config = new MicrofrontendChildConfig({ config, overrides, meta });
     }
   }
   isChildConfig() {
-    return this.config instanceof MicroFrontendChildConfig;
+    return this.config instanceof MicrofrontendChildConfig;
   }
   static fromEnv({
     cookies,
     meta
   }) {
-    const config = MicroFrontendConfigIsomorphic.fromEnv({
+    const config = MicrofrontendConfigIsomorphic.fromEnv({
       cookies,
       meta
     });
@@ -838,14 +838,14 @@ var import_jsonc_parser2 = require("jsonc-parser");
 var import_ajv = require("ajv");
 
 // src/config/errors.ts
-var MicroFrontendError2 = class extends Error {
+var MicrofrontendError2 = class extends Error {
   constructor(message, opts) {
     super(message);
-    this.name = "MicroFrontendsError";
-    this.source = (opts == null ? void 0 : opts.source) ?? "@vercel/micro-frontends";
+    this.name = "MicrofrontendsError";
+    this.source = (opts == null ? void 0 : opts.source) ?? "@vercel/microfrontends";
     this.type = (opts == null ? void 0 : opts.type) ?? "unknown";
     this.subtype = opts == null ? void 0 : opts.subtype;
-    Error.captureStackTrace(this, MicroFrontendError2);
+    Error.captureStackTrace(this, MicrofrontendError2);
   }
   isKnown() {
     return this.type !== "unknown";
@@ -854,13 +854,13 @@ var MicroFrontendError2 = class extends Error {
     return !this.isKnown();
   }
   /**
-   * Converts an error to a MicroFrontendsError.
+   * Converts an error to a MicrofrontendsError.
    * @param original - The original error to convert.
-   * @returns The converted MicroFrontendsError.
+   * @returns The converted MicrofrontendsError.
    */
   static convert(original, opts) {
     if (opts == null ? void 0 : opts.fileName) {
-      const err = MicroFrontendError2.convertFSError(original, opts.fileName);
+      const err = MicrofrontendError2.convertFSError(original, opts.fileName);
       if (err) {
         return err;
       }
@@ -868,25 +868,25 @@ var MicroFrontendError2 = class extends Error {
     if (original.message.includes(
       "Code generation from strings disallowed for this context"
     )) {
-      return new MicroFrontendError2(original.message, {
+      return new MicrofrontendError2(original.message, {
         type: "config",
         subtype: "unsupported_validation_env",
         source: "ajv"
       });
     }
-    return new MicroFrontendError2(original.message);
+    return new MicrofrontendError2(original.message);
   }
   static convertFSError(original, fileName) {
     if (original instanceof Error && "code" in original) {
       if (original.code === "ENOENT") {
-        return new MicroFrontendError2(`Could not find "${fileName}"`, {
+        return new MicrofrontendError2(`Could not find "${fileName}"`, {
           type: "config",
           subtype: "unable_to_read_file",
           source: "fs"
         });
       }
       if (original.code === "EACCES") {
-        return new MicroFrontendError2(
+        return new MicrofrontendError2(
           `Permission denied while accessing "${fileName}"`,
           {
             type: "config",
@@ -897,7 +897,7 @@ var MicroFrontendError2 = class extends Error {
       }
     }
     if (original instanceof SyntaxError) {
-      return new MicroFrontendError2(
+      return new MicrofrontendError2(
         `Failed to parse "${fileName}": Invalid JSON format.`,
         {
           type: "config",
@@ -909,23 +909,23 @@ var MicroFrontendError2 = class extends Error {
     return null;
   }
   /**
-   * Handles an unknown error and returns a MicroFrontendsError instance.
+   * Handles an unknown error and returns a MicrofrontendsError instance.
    * @param err - The error to handle.
-   * @returns A MicroFrontendsError instance.
+   * @returns A MicrofrontendsError instance.
    */
   static handle(err, opts) {
-    if (err instanceof MicroFrontendError2) {
+    if (err instanceof MicrofrontendError2) {
       return err;
     }
     if (err instanceof Error) {
-      return MicroFrontendError2.convert(err, opts);
+      return MicrofrontendError2.convert(err, opts);
     }
     if (typeof err === "object" && err !== null) {
       if ("message" in err && typeof err.message === "string") {
-        return MicroFrontendError2.convert(new Error(err.message), opts);
+        return MicrofrontendError2.convert(new Error(err.message), opts);
       }
     }
-    return new MicroFrontendError2("An unknown error occurred");
+    return new MicrofrontendError2("An unknown error occurred");
   }
 };
 
@@ -1203,7 +1203,7 @@ function validateSchema(configString) {
   const validate = ajv.compile(SCHEMA);
   const isValid = validate(parsedConfig);
   if (!isValid) {
-    throw new MicroFrontendError2(
+    throw new MicrofrontendError2(
       `Invalid config: ${ajv.errorsText(validate.errors)}`,
       { type: "config", subtype: "does_not_match_schema" }
     );
@@ -1254,7 +1254,7 @@ var MicrofrontendsServer = class extends Microfrontends {
         meta
       });
     }
-    throw new MicroFrontendError(
+    throw new MicrofrontendError(
       "Invalid config: must be a string or an object",
       { type: "config", subtype: "does_not_match_schema" }
     );
@@ -1299,7 +1299,44 @@ var MicrofrontendsServer = class extends Microfrontends {
         meta
       });
     } catch (e) {
-      throw MicroFrontendError.handle(e, {
+      throw MicrofrontendError.handle(e, {
+        fileName: filePath
+      });
+    }
+  }
+  /*
+   * Generates a MicrofrontendMainConfig instance from a file.
+   */
+  static fromMainConfigFile({
+    filePath,
+    overrides
+  }) {
+    try {
+      const config = import_node_fs.default.readFileSync(filePath, "utf-8");
+      const validatedConfig = MicrofrontendsServer.validate(config);
+      if (!isMainConfig(validatedConfig)) {
+        throw new MicrofrontendError(
+          `${filePath} is not a main microfrontend config`,
+          {
+            type: "config",
+            subtype: "invalid_main_path"
+          }
+        );
+      }
+      const [defaultApplication] = Object.entries(validatedConfig.applications).filter(([, app]) => isDefaultApp(app)).map(([name]) => name);
+      if (!defaultApplication) {
+        throw new MicrofrontendError(
+          `No default application found. At least one application needs to be the default by omitting routing.`,
+          { type: "config", subtype: "no_default_application" }
+        );
+      }
+      return new MicrofrontendsServer({
+        config: validatedConfig,
+        overrides,
+        meta: { fromApp: defaultApplication }
+      });
+    } catch (e) {
+      throw MicrofrontendError.handle(e, {
         fileName: filePath
       });
     }