@vercel/microfrontends 0.17.4 → 0.19.0

package/schema/schema.json

@@ -25,16 +25,6 @@
         "options": {
           "$ref": "#/definitions/Options"
         },
-        "remotes": {
-          "type": "object",
-          "additionalProperties": {
-            "$ref": "#/definitions/Application"
-          },
-          "propertyNames": {
-            "description": "The unique identifier for a Microfrontend Application. Must match the `name` field of the application's `package.json`."
-          },
-          "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"
@@ -50,11 +40,21 @@
       "properties": {
         "vercel": {
           "$ref": "#/definitions/VercelOptions",
-          "description": "Micro-Frontends wide options for Vercel."
+          "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."
+          "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`."
         }
       },
       "additionalProperties": false
@@ -62,10 +62,6 @@
     "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."
@@ -83,6 +79,15 @@
       },
       "additionalProperties": false
     },
+    "ApplicationRouting": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/Application"
+      },
+      "propertyNames": {
+        "description": "The unique identifier for a Microfrontend Application. Must match the `name` field of the application's `package.json`."
+      }
+    },
     "Application": {
       "anyOf": [
         {
@@ -97,18 +102,21 @@
       "type": "object",
       "properties": {
         "vercel": {
-          "$ref": "#/definitions/Vercel"
+          "$ref": "#/definitions/Vercel",
+          "deprecated": "This is being replaced by the `projectId` field below."
         },
-        "development": {
-          "$ref": "#/definitions/Development"
+        "projectId": {
+          "type": "string",
+          "description": "Vercel project ID"
         },
         "production": {
-          "$ref": "#/definitions/HostConfig"
+          "$ref": "#/definitions/HostConfig",
+          "deprecated": "This is a duplicate of the `development.fallback` field and this will be removed soon."
+        },
+        "development": {
+          "$ref": "#/definitions/Development"
         }
       },
-      "required": [
-        "production"
-      ],
       "additionalProperties": false
     },
     "Vercel": {
@@ -124,15 +132,52 @@
       ],
       "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": {
       "type": "object",
       "properties": {
         "local": {
-          "$ref": "#/definitions/LocalHostConfig"
+          "$ref": "#/definitions/LocalHostConfig",
+          "deprecated": "This is being replaced by the `localPort` field below."
+        },
+        "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."
         },
         "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."
+          "anyOf": [
+            {
+              "$ref": "#/definitions/HostConfig"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "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.\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."
         },
         "task": {
           "type": "string",
@@ -163,36 +208,20 @@
         }
       }
     },
-    "HostConfig": {
+    "ChildApplication": {
       "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*"
+        "vercel": {
+          "$ref": "#/definitions/Vercel",
+          "deprecated": "This is being replaced by the `projectId` field below."
         },
-        "host": {
+        "projectId": {
           "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": "Vercel project ID"
         },
-        "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
-    },
-    "ChildApplication": {
-      "type": "object",
-      "properties": {
-        "vercel": {
-          "$ref": "#/definitions/Vercel"
+        "production": {
+          "$ref": "#/definitions/HostConfig",
+          "deprecated": "This is a duplicate of the `development.fallback` field and this will be removed soon."
         },
         "development": {
           "$ref": "#/definitions/Development"
@@ -200,9 +229,6 @@
         "routing": {
           "$ref": "#/definitions/Routing",
           "description": "Groups of path expressions that are routed to this application."
-        },
-        "production": {
-          "$ref": "#/definitions/HostConfig"
         }
       },
       "required": [
@@ -239,15 +265,6 @@
       ],
       "additionalProperties": false
     },
-    "ApplicationRouting": {
-      "type": "object",
-      "additionalProperties": {
-        "$ref": "#/definitions/Application"
-      },
-      "propertyNames": {
-        "description": "The unique identifier for a Microfrontend Application. Must match the `name` field of the application's `package.json`."
-      }
-    },
     "ChildConfig": {
       "type": "object",
       "properties": {
@@ -261,16 +278,6 @@
         "options": {
           "$ref": "#/definitions/Options"
         },
-        "remotes": {
-          "type": "object",
-          "additionalProperties": {
-            "$ref": "#/definitions/Application"
-          },
-          "propertyNames": {
-            "description": "The unique identifier for a Microfrontend Application. Must match the `name` field of the application's `package.json`."
-          },
-          "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."