@vercel/microfrontends 1.1.1-canary.6 → 1.2.0

package/dist/utils/mfe-port.cjs

@@ -430,8 +430,7 @@ var validateConfigPaths = (applicationConfigsById) => {
     if (isDefaultApp(app)) {
       continue;
     }
-    const childApp = app;
-    for (const pathMatch of childApp.routing) {
+    for (const pathMatch of app.routing) {
       for (const path7 of pathMatch.paths) {
         const maybeError = validatePathExpression(path7);
         if (maybeError) {
@@ -579,64 +578,15 @@ 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?.localPort) {
       errors.push(
         `Application '${applicationId}' cannot contain deprecated field 'development.localPort'. Use 'developement.local' instead.`
       );
     }
-    if (application.development?.fallback && typeof application.development.fallback !== "string") {
-      const fallback = application.development.fallback;
-      let asString = fallback.host;
-      if (fallback.protocol) {
-        asString = `${fallback.protocol}://${asString}`;
-      }
-      if (fallback.port) {
-        asString = `${asString}:${fallback.port}`;
-      }
-      errors.push(
-        `Application '${applicationId}' requires a string (not an object) for the 'development.fallback' field. Please set 'development.fallback' to '${asString}'.`
-      );
-    }
-    if (application.development?.local && typeof application.development.local !== "string" && typeof application.development.local !== "number") {
-      const local = application.development.local;
-      let asString;
-      if (local.port && !local.protocol && !local.host) {
-        asString = String(local.port);
-      } else {
-        asString = local.host ?? "localhost";
-        if (local.protocol) {
-          asString = `${local.protocol}://${asString}`;
-        }
-        if (local.port) {
-          asString = `${asString}:${local.port}`;
-        }
-      }
-      errors.push(
-        `Application '${applicationId}' requires a string or number (not an object) for the 'development.local' field. Please set 'development.local' to '${asString}'.`
-      );
+    if (application.projectId) {
     }
   }
   if (errors.length) {
@@ -791,6 +741,13 @@ var LocalHost = class extends Host {
   }
 };
 
+// src/config/microfrontends-config/isomorphic/utils/generate-automation-bypass-env-var-name.ts
+function generateAutomationBypassEnvVarName({
+  name
+}) {
+  return `AUTOMATION_BYPASS_${name.toUpperCase().replace(/[^a-zA-Z0-9]/g, "_")}`;
+}
+
 // src/config/microfrontends-config/isomorphic/application.ts
 var Application = class {
   constructor(name, {
@@ -809,10 +766,8 @@ var Application = class {
     };
     if (app.development?.fallback) {
       this.fallback = new Host(app.development.fallback);
-    } else if (app.production) {
-      this.fallback = new Host(app.production);
     }
-    this.projectId = app.projectId ?? app.vercel?.projectId;
+    this.projectId = app.projectId;
     this.packageName = app.packageName;
     this.overrides = overrides?.environment ? {
       environment: new Host(overrides.environment)
@@ -826,6 +781,9 @@ var Application = class {
   getAssetPrefix() {
     return generateAssetPrefixFromName({ name: this.name });
   }
+  getAutomationBypassEnvVarName() {
+    return generateAutomationBypassEnvVarName({ name: this.name });
+  }
   serialize() {
     return this.serialized;
   }
@@ -841,16 +799,7 @@ var DefaultApplication = class extends Application {
       isDefault: true
     });
     this.default = true;
-    const fallbackHost = app.development?.fallback ?? app.production;
-    if (fallbackHost === void 0) {
-      throw new Error(
-        "`app.production` or `app.development.fallback` must be set in the default application in microfrontends.json."
-      );
-    }
-    this.fallback = new Host(fallbackHost);
-    if (app.production) {
-      this.production = new Host(app.production);
-    }
+    this.fallback = new Host(app.development.fallback);
   }
   getAssetPrefix() {
     return "";
@@ -887,7 +836,7 @@ var MicrofrontendConfigIsomorphic = class {
   }) {
     this.childApplications = {};
     MicrofrontendConfigIsomorphic.validate(config, opts);
-    const disableOverrides = config.options?.disableOverrides ?? config.options?.vercel?.disableOverrides ?? false;
+    const disableOverrides = config.options?.disableOverrides ?? false;
     this.overrides = overrides && !disableOverrides ? overrides : void 0;
     let defaultApplication;
     for (const [appId, appConfig] of Object.entries(config.applications)) {
@@ -940,7 +889,7 @@ var MicrofrontendConfigIsomorphic = class {
     });
   }
   isOverridesDisabled() {
-    return this.options?.vercel?.disableOverrides ?? false;
+    return this.options?.disableOverrides ?? false;
   }
   getConfig() {
     return this.config;
@@ -978,6 +927,14 @@ var MicrofrontendConfigIsomorphic = class {
     }
     return app;
   }
+  hasApplication(name) {
+    try {
+      this.getApplication(name);
+      return true;
+    } catch {
+      return false;
+    }
+  }
   getApplicationByProjectId(projectId) {
     if (this.defaultApplication.projectId === projectId) {
       return this.defaultApplication;
@@ -996,7 +953,7 @@ var MicrofrontendConfigIsomorphic = class {
    * Returns the configured port for the local proxy
    */
   getLocalProxyPort() {
-    return this.config.options?.localProxyPort ?? this.config.options?.localProxy?.port ?? DEFAULT_LOCAL_PROXY_PORT;
+    return this.config.options?.localProxyPort ?? DEFAULT_LOCAL_PROXY_PORT;
   }
   /**
    * Serializes the class back to the Schema type.
@@ -1107,20 +1064,10 @@ var schema_default = {
     Options: {
       type: "object",
       properties: {
-        vercel: {
-          $ref: "#/definitions/VercelOptions",
-          description: "Microfrontends wide options for Vercel.",
-          deprecated: "This is being replaced by the `disableOverrides` field below."
-        },
         disableOverrides: {
           type: "boolean",
           description: "If you want to disable the overrides for the site. For example, if you are managing rewrites between applications externally, you may wish to disable the overrides on the toolbar as they will have no effect."
         },
-        localProxy: {
-          $ref: "#/definitions/LocalProxyOptions",
-          description: "Options for local proxy.",
-          deprecated: "This is being replaced by the `localProxyPort` field below."
-        },
         localProxyPort: {
           type: "number",
           description: "The port number used by the local proxy server.\n\nThe default is `3024`."
@@ -1128,26 +1075,6 @@ var schema_default = {
       },
       additionalProperties: false
     },
-    VercelOptions: {
-      type: "object",
-      properties: {
-        disableOverrides: {
-          type: "boolean",
-          description: "If you want to disable the overrides for the site. For example, if you are managing rewrites between applications externally, you may wish to disable the overrides on the toolbar as they will have no effect."
-        }
-      },
-      additionalProperties: false
-    },
-    LocalProxyOptions: {
-      type: "object",
-      properties: {
-        port: {
-          type: "number",
-          description: "The port number used by the local proxy server.\n\nThe default is `3024`."
-        }
-      },
-      additionalProperties: false
-    },
     ApplicationRouting: {
       type: "object",
       additionalProperties: {
@@ -1170,141 +1097,62 @@ var schema_default = {
     DefaultApplication: {
       type: "object",
       properties: {
-        vercel: {
-          $ref: "#/definitions/Vercel",
-          deprecated: "This is being replaced by the `projectId` field below."
-        },
         projectId: {
           type: "string",
           description: "Vercel project ID, only required if the application name / id is different to the Vercel project name.",
-          deprecated: "Instead, the application id should match the Vercel project name."
+          deprecated: "Instead, the application id should match the Vercel project name. `packageName` can optionally\nbe set to the name of the package.json (if it is different from the project name)."
         },
         packageName: {
           type: "string",
           description: "The name used to run the application, e.g. the `name` field in the `package.json`.\n\nThis is used by the local proxy to map the application config to the locally running app.\n\nThis is only necessary when the application name does not match the `name` used in `package.json`."
         },
-        production: {
-          $ref: "#/definitions/HostConfig",
-          deprecated: "This is a duplicate of the `development.fallback` field and this will be removed soon."
-        },
         development: {
-          $ref: "#/definitions/Development"
+          $ref: "#/definitions/DefaultDevelopment",
+          description: "Development configuration for the default application."
         }
       },
+      required: ["development"],
       additionalProperties: false
     },
-    Vercel: {
-      type: "object",
-      properties: {
-        projectId: {
-          type: "string",
-          description: "Vercel project ID"
-        }
-      },
-      required: ["projectId"],
-      additionalProperties: false
-    },
-    HostConfig: {
-      type: "object",
-      properties: {
-        protocol: {
-          type: "string",
-          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: {
-          type: "string",
-          description: "The hostname or IP address of the server. This can be a domain name (e.g., `example.com`) or an IP address (e.g., `192.168.1.1`)."
-        },
-        port: {
-          type: "number",
-          description: "The port number to be used for the connection. Common values include `80` for HTTP and `443` for HTTPS."
-        }
-      },
-      required: ["host"],
-      additionalProperties: false
-    },
-    Development: {
+    DefaultDevelopment: {
       type: "object",
       properties: {
         local: {
-          anyOf: [
-            {
-              type: "number"
-            },
-            {
-              type: "string"
-            },
-            {
-              $ref: "#/definitions/LocalHostConfig"
-            }
-          ],
-          description: "A local port number or host string that this application runs on when it is running locally. If passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTP. If omitted, the port defaults to a unique, but stable (based on the application name) number.\n\nExamples of valid values:\n- 8080\n- my.localhost.me\n- my.localhost.me:8080\n- https://my.localhost.me\n- https://my.localhost.me:8080\n\nPassing a LocalHostConfig is deprecated and will go away soon, please pass a number or string."
+          type: ["number", "string"],
+          description: "A local port number or host string that this application runs on when it is running locally. If passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTP. If omitted, the port defaults to a unique, but stable (based on the application name) number.\n\nExamples of valid values:\n- 8080\n- my.localhost.me\n- my.localhost.me:8080\n- https://my.localhost.me\n- https://my.localhost.me:8080"
         },
         localPort: {
           type: "number",
           description: "The local port number that this application runs on when it is running locally. Common values include `80` for HTTP and `443` for HTTPS. If omitted, the port defaults to a unique, but stable (based on the application name) number.",
           deprecated: "Please set the port with the 'local' field instead."
         },
-        fallback: {
-          anyOf: [
-            {
-              $ref: "#/definitions/HostConfig"
-            },
-            {
-              type: "string"
-            }
-          ],
-          description: "Fallback for local development, could point to any environment. If this is not provided, or the application is not running - requests to the application in local development will error.\n\nIf passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTPS. If omitted, the port defaults to `80` for HTTP and `443` for HTTPS.\n\nPassing a HostConfig is deprecated and will go away soon, please pass a string."
-        },
         task: {
           type: "string",
           description: "Optional task to run when starting the development server. Should reference a script in the package.json of the application."
-        }
-      },
-      additionalProperties: false
-    },
-    LocalHostConfig: {
-      type: "object",
-      additionalProperties: false,
-      properties: {
-        host: {
-          type: "string",
-          description: "The hostname or IP address of the server. This can be a domain name (e.g., `example.com`) or an IP address (e.g., `192.168.1.1`)."
         },
-        protocol: {
+        fallback: {
           type: "string",
-          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: {
-          type: "number",
-          description: "The port number to be used for the connection. Common values include `80` for HTTP and `443` for HTTPS."
+          description: "Fallback for local development, could point to any environment. This is required for the default app. This value is used as the fallback for child apps as well if they do not have a fallback.\n\nIf passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTPS. If omitted, the port defaults to `80` for HTTP and `443` for HTTPS."
         }
-      }
+      },
+      required: ["fallback"],
+      additionalProperties: false
     },
     ChildApplication: {
       type: "object",
       properties: {
-        vercel: {
-          $ref: "#/definitions/Vercel",
-          deprecated: "This is being replaced by the `projectId` field below."
-        },
         projectId: {
           type: "string",
           description: "Vercel project ID, only required if the application name / id is different to the Vercel project name.",
-          deprecated: "Instead, the application id should match the Vercel project name."
+          deprecated: "Instead, the application id should match the Vercel project name. `packageName` can optionally\nbe set to the name of the package.json (if it is different from the project name)."
         },
         packageName: {
           type: "string",
           description: "The name used to run the application, e.g. the `name` field in the `package.json`.\n\nThis is used by the local proxy to map the application config to the locally running app.\n\nThis is only necessary when the application name does not match the `name` used in `package.json`."
         },
-        production: {
-          $ref: "#/definitions/HostConfig",
-          deprecated: "This is a duplicate of the `development.fallback` field and this will be removed soon."
-        },
         development: {
-          $ref: "#/definitions/Development"
+          $ref: "#/definitions/ChildDevelopment",
+          description: "Development configuration for the child application."
         },
         routing: {
           $ref: "#/definitions/Routing",
@@ -1314,6 +1162,29 @@ var schema_default = {
       required: ["routing"],
       additionalProperties: false
     },
+    ChildDevelopment: {
+      type: "object",
+      properties: {
+        local: {
+          type: ["number", "string"],
+          description: "A local port number or host string that this application runs on when it is running locally. If passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTP. If omitted, the port defaults to a unique, but stable (based on the application name) number.\n\nExamples of valid values:\n- 8080\n- my.localhost.me\n- my.localhost.me:8080\n- https://my.localhost.me\n- https://my.localhost.me:8080"
+        },
+        localPort: {
+          type: "number",
+          description: "The local port number that this application runs on when it is running locally. Common values include `80` for HTTP and `443` for HTTPS. If omitted, the port defaults to a unique, but stable (based on the application name) number.",
+          deprecated: "Please set the port with the 'local' field instead."
+        },
+        task: {
+          type: "string",
+          description: "Optional task to run when starting the development server. Should reference a script in the package.json of the application."
+        },
+        fallback: {
+          type: "string",
+          description: "Fallback for local development, could point to any environment. This is optional for child apps. If not provided, the fallback of the default app will be used.\n\nIf passing a string, include the protocol (optional), host (required) and port (optional). For example: `https://this.ismyhost:8080`. If omitted, the protocol defaults to HTTPS. If omitted, the port defaults to `80` for HTTP and `443` for HTTPS."
+        }
+      },
+      additionalProperties: false
+    },
     Routing: {
       type: "array",
       items: {
@@ -1399,7 +1270,7 @@ function formatAjvErrors(errors) {
 }
 function validateSchema(configString) {
   const parsedConfig = (0, import_jsonc_parser3.parse)(configString);
-  const ajv = new import_ajv.Ajv();
+  const ajv = new import_ajv.Ajv({ allowUnionTypes: true });
   const validate = ajv.compile(SCHEMA);
   const isValid = validate(parsedConfig);
   if (!isValid) {