@vercel/microfrontends 0.14.0 → 0.16.0

package/schema/schema.json

@@ -3,346 +3,276 @@
   "$ref": "#/definitions/Config",
   "definitions": {
     "Config": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/MainConfig"
+        },
+        {
+          "$ref": "#/definitions/ChildConfig"
+        }
+      ]
+    },
+    "MainConfig": {
       "type": "object",
       "properties": {
-        "version": {
-          "type": "string"
-        },
         "$schema": {
           "type": "string"
         },
-        "name": {
+        "version": {
           "type": "string",
-          "description": "Name for the micro-frontend site (eg. \"vercel.com\", \"vercel-site\" etc.)."
-        },
-        "applications": {
-          "$ref": "#/definitions/ApplicationConfigsById"
+          "const": "2"
         },
         "options": {
-          "$ref": "#/definitions/Options",
-          "description": "Optional configuration for the entire micro-frontends setup."
+          "$ref": "#/definitions/Options"
+        },
+        "remotes": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/Application"
+          },
+          "description": "Applications that only serve a subset of the microfrontend routes only need to reference the name of the primary application that owns the full microfrontends configuration."
+        },
+        "applications": {
+          "$ref": "#/definitions/ApplicationRouting",
+          "description": "Mapping of application names to the routes that they host. Only needs to be defined in the application that owns the primary microfrontend domain"
         }
       },
       "required": [
-        "version",
-        "applications"
+        "applications",
+        "version"
       ],
-      "description": "Configuration for micro-frontend applications\n\nTODO: Add proxy configuration"
+      "additionalProperties": false
     },
-    "ApplicationConfigsById": {
+    "Options": {
       "type": "object",
-      "additionalProperties": {
-        "$ref": "#/definitions/ApplicationConfig"
-      }
+      "properties": {
+        "vercel": {
+          "$ref": "#/definitions/VercelOptions",
+          "description": "Micro-Frontends wide options for Vercel."
+        },
+        "localProxy": {
+          "$ref": "#/definitions/LocalProxyOptions",
+          "description": "Options for local proxy."
+        }
+      },
+      "additionalProperties": false
+    },
+    "VercelOptions": {
+      "type": "object",
+      "properties": {
+        "teamSlug": {
+          "type": "string",
+          "description": "Team slug for the Vercel team"
+        },
+        "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
     },
-    "ApplicationConfig": {
+    "Application": {
       "anyOf": [
         {
-          "$ref": "#/definitions/DefaultApplicationConfig"
+          "$ref": "#/definitions/DefaultApplication"
         },
         {
-          "$ref": "#/definitions/CommonApplicationConfig"
+          "$ref": "#/definitions/ChildApplication"
         }
-      ],
-      "description": "A Micro-Frontend Deployment Target"
+      ]
     },
-    "DefaultApplicationConfig": {
+    "DefaultApplication": {
       "type": "object",
       "properties": {
-        "default": {
-          "type": "boolean",
-          "const": true,
-          "description": "The default application is used no other application is matched via the routing config"
-        },
-        "routing": {
-          "$ref": "#/definitions/Routing"
+        "vercel": {
+          "$ref": "#/definitions/Vercel"
         },
         "development": {
-          "type": "object",
-          "properties": {
-            "local": {
-              "$ref": "#/definitions/HostConfig"
-            },
-            "fallback": {
-              "$ref": "#/definitions/HostConfig",
-              "description": "Fallback for local development, could be a host config that points to any environment. If this is not provided, or the application is not running - requests to the application in local development will error."
-            },
-            "task": {
-              "type": "string",
-              "description": "Optional task to run when starting the development server. Should reference a script in the package.json of the application."
-            }
-          },
-          "required": [
-            "local"
-          ]
+          "$ref": "#/definitions/Development"
         },
         "production": {
           "$ref": "#/definitions/HostConfig"
-        },
-        "metadata": {
-          "type": "object",
-          "additionalProperties": {
-            "type": "string"
-          }
-        },
-        "federation": {
-          "type": "object",
-          "properties": {
-            "exposes": {
-              "type": "array",
-              "items": {
-                "type": "object",
-                "properties": {
-                  "name": {
-                    "type": "string",
-                    "description": "The name of the module - should be used when importing the module from another application"
-                  },
-                  "path": {
-                    "type": "string",
-                    "description": "Relative path to the module within its `application`"
-                  }
-                },
-                "required": [
-                  "name",
-                  "path"
-                ]
-              },
-              "description": "Modules that are exposed by this application"
-            },
-            "uses": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "description": "Modules that are used by this application. Only the name of the module is required."
-            }
-          }
-        },
-        "vercel": {
-          "$ref": "#/definitions/Vercel"
         }
       },
       "required": [
-        "default",
-        "development",
         "production"
-      ]
+      ],
+      "additionalProperties": false
     },
-    "Routing": {
+    "Vercel": {
       "type": "object",
       "properties": {
-        "assetPrefix": {
+        "projectId": {
           "type": "string",
-          "description": "[assetPrefix] for the application"
-        },
-        "matches": {
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/PathGroup"
-          },
-          "description": "Path expressions that are routed to this application."
+          "description": "Vercel project ID"
         }
       },
       "required": [
-        "matches"
-      ]
+        "projectId"
+      ],
+      "additionalProperties": false
     },
-    "PathGroup": {
+    "Development": {
       "type": "object",
       "properties": {
-        "group": {
-          "type": "string",
-          "description": "Optional group name for the paths"
+        "local": {
+          "$ref": "#/definitions/LocalHostConfig"
         },
-        "options": {
-          "type": "object",
-          "properties": {
-            "flag": {
-              "type": "string",
-              "description": "flag name that can be used to enable/disable all paths in the group"
-            }
-          }
+        "fallback": {
+          "$ref": "#/definitions/HostConfig",
+          "description": "Fallback for local development, could be a host config that points to any environment. If this is not provided, or the application is not running - requests to the application in local development will error."
         },
-        "paths": {
-          "type": "array",
-          "items": {
-            "type": "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."
         }
       },
-      "required": [
-        "paths"
-      ]
+      "additionalProperties": false
     },
-    "HostConfig": {
+    "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": {
           "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* @defaultValue \"https\""
-        },
-        "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`)."
+          "description": "The protocol to be used for the connection.\n- `http`: Hypertext Transfer Protocol (HTTP).\n- `https`: Secure Hypertext Transfer Protocol (HTTPS).\n\n* @defaultValue \"http\" for local development, \"https\" for otherwise"
         },
         "port": {
           "type": "number",
-          "description": "The port number to be used for the connection. Common values include `80` for HTTP and `443` for HTTPS.\n\nThis field is optional and can be omitted if the default ports for the specified protocol are used"
+          "description": "The port number to be used for the connection. Common values include `80` for HTTP and `443` for HTTPS."
         }
-      },
-      "required": [
-        "host"
-      ]
+      }
     },
-    "Vercel": {
+    "HostConfig": {
       "type": "object",
       "properties": {
-        "projectId": {
-          "type": "string",
-          "description": "Vercel project ID"
-        },
-        "projectName": {
+        "protocol": {
           "type": "string",
-          "description": "Vercel project name (temporary until we can use project ID)"
+          "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* @defaultValue \"http\" for local development, \"https\" for otherwise"
         },
-        "defaultRoute": {
+        "host": {
           "type": "string",
-          "description": "The default route for the application. Used to render screenshots, favicons, and provide direct zone links"
+          "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`)."
         },
-        "routeSpeedInsightsToDefaultZone": {
-          "type": "boolean",
-          "description": "Whether to route Speed Insights to the default zone or each individual microfrontend."
+        "port": {
+          "type": "number",
+          "description": "The port number to be used for the connection. Common values include `80` for HTTP and `443` for HTTPS."
         }
       },
       "required": [
-        "projectId"
-      ]
+        "host"
+      ],
+      "additionalProperties": false
     },
-    "CommonApplicationConfig": {
+    "ChildApplication": {
       "type": "object",
       "properties": {
-        "default": {
-          "type": "boolean",
-          "const": false,
-          "description": "The default application is used no other application is matched via the routing config"
-        },
-        "routing": {
-          "$ref": "#/definitions/Routing"
+        "vercel": {
+          "$ref": "#/definitions/Vercel"
         },
         "development": {
-          "type": "object",
-          "properties": {
-            "local": {
-              "$ref": "#/definitions/HostConfig"
-            },
-            "fallback": {
-              "$ref": "#/definitions/HostConfig",
-              "description": "Fallback for local development, could be a host config that points to any environment. If this is not provided, or the application is not running - requests to the application in local development will error."
-            },
-            "task": {
-              "type": "string",
-              "description": "Optional task to run when starting the development server. Should reference a script in the package.json of the application."
-            }
-          },
-          "required": [
-            "local"
-          ]
+          "$ref": "#/definitions/Development"
+        },
+        "routing": {
+          "$ref": "#/definitions/Routing",
+          "description": "Groups of path expressions that are routed to this application."
         },
         "production": {
           "$ref": "#/definitions/HostConfig"
-        },
-        "metadata": {
-          "type": "object",
-          "additionalProperties": {
-            "type": "string"
-          }
-        },
-        "federation": {
-          "type": "object",
-          "properties": {
-            "exposes": {
-              "type": "array",
-              "items": {
-                "type": "object",
-                "properties": {
-                  "name": {
-                    "type": "string",
-                    "description": "The name of the module - should be used when importing the module from another application"
-                  },
-                  "path": {
-                    "type": "string",
-                    "description": "Relative path to the module within its `application`"
-                  }
-                },
-                "required": [
-                  "name",
-                  "path"
-                ]
-              },
-              "description": "Modules that are exposed by this application"
-            },
-            "uses": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "description": "Modules that are used by this application. Only the name of the module is required."
-            }
-          }
-        },
-        "vercel": {
-          "$ref": "#/definitions/Vercel"
         }
       },
       "required": [
-        "default",
-        "development",
-        "production",
         "routing"
-      ]
+      ],
+      "additionalProperties": false
     },
-    "Options": {
-      "type": "object",
-      "properties": {
-        "vercel": {
-          "$ref": "#/definitions/VercelOptions",
-          "description": "Micro-Frontends wide options for Vercel."
-        },
-        "localProxy": {
-          "$ref": "#/definitions/LocalProxyOptions",
-          "description": "Options for local proxy."
-        }
+    "Routing": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/PathGroup"
       }
     },
-    "VercelOptions": {
+    "PathGroup": {
       "type": "object",
       "properties": {
-        "previewDeploymentSuffix": {
+        "group": {
           "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`."
+          "description": "Optional group name for the paths"
         },
-        "teamSlug": {
+        "flag": {
           "type": "string",
-          "description": "Team slug for the Vercel team"
+          "description": "flag name that can be used to enable/disable all paths in the group"
         },
-        "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."
+        "paths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
+      },
+      "required": [
+        "paths"
+      ],
+      "additionalProperties": false
+    },
+    "ApplicationRouting": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/Application"
       }
     },
-    "LocalProxyOptions": {
+    "ChildConfig": {
       "type": "object",
       "properties": {
-        "port": {
-          "type": "number",
-          "description": "The port number used by the local proxy server.\n\nThe default is `3024`."
+        "$schema": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string",
+          "const": "2"
+        },
+        "options": {
+          "$ref": "#/definitions/Options"
+        },
+        "remotes": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/Application"
+          },
+          "description": "Applications that only serve a subset of the microfrontend routes only need to reference the name of the primary application that owns the full microfrontends configuration."
+        },
+        "partOf": {
+          "type": "string",
+          "description": "Applications that only serve a subset of the microfrontend routes only need to reference the name of the primary application that owns the full microfrontends configuration."
         }
-      }
+      },
+      "required": [
+        "partOf",
+        "version"
+      ],
+      "additionalProperties": false
     }
   }
 }

package/dist/config/client.cjs

@@ -1,54 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/config/client/client-config.ts
-var client_config_exports = {};
-__export(client_config_exports, {
-  getClientConfigFromEnv: () => getClientConfigFromEnv,
-  getConfigForClient: () => getConfigForClient
-});
-module.exports = __toCommonJS(client_config_exports);
-function getConfigForClient(config) {
-  return {
-    applications: Object.fromEntries(
-      Object.entries(config.applications).map(([name, application]) => [
-        name,
-        {
-          default: application.default,
-          routing: application.routing
-        }
-      ])
-    )
-  };
-}
-function getClientConfigFromEnv() {
-  const clientConfigJson = process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG;
-  if (!clientConfigJson) {
-    throw new Error(
-      "Could not find client micro-frontends config in the environment"
-    );
-  }
-  return JSON.parse(clientConfigJson);
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  getClientConfigFromEnv,
-  getConfigForClient
-});
-//# sourceMappingURL=client.cjs.map

package/dist/config/client.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/config/client/client-config.ts"],"sourcesContent":["import type { Config } from '../schema';\nimport type { ClientConfig, WellKnownClientData } from './types';\n\n/**\n * Given a micro-frontends configuration, this returns a version that is\n * acceptable to be used client-side without leaking any information.\n */\nexport function getConfigForClient(config: Config): ClientConfig {\n  return {\n    applications: Object.fromEntries(\n      Object.entries(config.applications).map(([name, application]) => [\n        name,\n        {\n          default: application.default,\n          routing: application.routing,\n        },\n      ]),\n    ),\n  };\n}\n\nexport function getClientConfigFromEnv(): ClientConfig {\n  // This has to use the actual name rather than the constant variable in order\n  // for the env var to be replaced during the build correctly.\n  const clientConfigJson = process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG;\n  if (!clientConfigJson) {\n    throw new Error(\n      'Could not find client micro-frontends config in the environment',\n    );\n  }\n  return JSON.parse(clientConfigJson) as ClientConfig;\n}\n\nexport type { ClientConfig, WellKnownClientData };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAOO,SAAS,mBAAmB,QAA8B;AAC/D,SAAO;AAAA,IACL,cAAc,OAAO;AAAA,MACnB,OAAO,QAAQ,OAAO,YAAY,EAAE,IAAI,CAAC,CAAC,MAAM,WAAW,MAAM;AAAA,QAC/D;AAAA,QACA;AAAA,UACE,SAAS,YAAY;AAAA,UACrB,SAAS,YAAY;AAAA,QACvB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAEO,SAAS,yBAAuC;AAGrD,QAAM,mBAAmB,QAAQ,IAAI;AACrC,MAAI,CAAC,kBAAkB;AACrB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,SAAO,KAAK,MAAM,gBAAgB;AACpC;","names":[]}

package/dist/config/client.d.ts

@@ -1,23 +0,0 @@
-import { A as ApplicationConfig, C as Config } from '../schema-2922d49e.js';
-
-type ClientApplicationConfig = Pick<ApplicationConfig, 'default' | 'routing'>;
-interface ClientConfig {
-    applications: Record<string, ClientApplicationConfig>;
-}
-/**
- * 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.
- */
-interface WellKnownClientData {
-    config: ClientConfig;
-}
-
-/**
- * Given a micro-frontends configuration, this returns a version that is
- * acceptable to be used client-side without leaking any information.
- */
-declare function getConfigForClient(config: Config): ClientConfig;
-declare function getClientConfigFromEnv(): ClientConfig;
-
-export { ClientConfig, WellKnownClientData, getClientConfigFromEnv, getConfigForClient };

package/dist/config/client.js

@@ -1,28 +0,0 @@
-// src/config/client/client-config.ts
-function getConfigForClient(config) {
-  return {
-    applications: Object.fromEntries(
-      Object.entries(config.applications).map(([name, application]) => [
-        name,
-        {
-          default: application.default,
-          routing: application.routing
-        }
-      ])
-    )
-  };
-}
-function getClientConfigFromEnv() {
-  const clientConfigJson = process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG;
-  if (!clientConfigJson) {
-    throw new Error(
-      "Could not find client micro-frontends config in the environment"
-    );
-  }
-  return JSON.parse(clientConfigJson);
-}
-export {
-  getClientConfigFromEnv,
-  getConfigForClient
-};
-//# sourceMappingURL=client.js.map

package/dist/config/client.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/config/client/client-config.ts"],"sourcesContent":["import type { Config } from '../schema';\nimport type { ClientConfig, WellKnownClientData } from './types';\n\n/**\n * Given a micro-frontends configuration, this returns a version that is\n * acceptable to be used client-side without leaking any information.\n */\nexport function getConfigForClient(config: Config): ClientConfig {\n  return {\n    applications: Object.fromEntries(\n      Object.entries(config.applications).map(([name, application]) => [\n        name,\n        {\n          default: application.default,\n          routing: application.routing,\n        },\n      ]),\n    ),\n  };\n}\n\nexport function getClientConfigFromEnv(): ClientConfig {\n  // This has to use the actual name rather than the constant variable in order\n  // for the env var to be replaced during the build correctly.\n  const clientConfigJson = process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG;\n  if (!clientConfigJson) {\n    throw new Error(\n      'Could not find client micro-frontends config in the environment',\n    );\n  }\n  return JSON.parse(clientConfigJson) as ClientConfig;\n}\n\nexport type { ClientConfig, WellKnownClientData };\n"],"mappings":";AAOO,SAAS,mBAAmB,QAA8B;AAC/D,SAAO;AAAA,IACL,cAAc,OAAO;AAAA,MACnB,OAAO,QAAQ,OAAO,YAAY,EAAE,IAAI,CAAC,CAAC,MAAM,WAAW,MAAM;AAAA,QAC/D;AAAA,QACA;AAAA,UACE,SAAS,YAAY;AAAA,UACrB,SAAS,YAAY;AAAA,QACvB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAEO,SAAS,yBAAuC;AAGrD,QAAM,mBAAmB,QAAQ,IAAI;AACrC,MAAI,CAAC,kBAAkB;AACrB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,SAAO,KAAK,MAAM,gBAAgB;AACpC;","names":[]}