@vercel/microfrontends 1.0.1-canary.5 → 1.1.1-canary.0

package/schema/schema.json

@@ -85,7 +85,7 @@
         "$ref": "#/definitions/Application"
       },
       "propertyNames": {
-        "description": "The unique identifier for a Microfrontend Application. Must match the `name` field of the application's `package.json`."
+        "description": "The unique identifier for a Microfrontend Application.\n\nMust match the Vercel project name.\n\nNote: If this name does not also match the name used to run the application, (e.g. the `name` from the `package.json`), then the `packageName` field should be set."
       }
     },
     "Application": {
@@ -107,7 +107,12 @@
         },
         "projectId": {
           "type": "string",
-          "description": "Vercel project ID"
+          "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."
+        },
+        "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",
@@ -161,12 +166,23 @@
       "type": "object",
       "properties": {
         "local": {
-          "$ref": "#/definitions/LocalHostConfig",
-          "deprecated": "This is being replaced by the `localPort` field below."
+          "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."
         },
         "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."
+          "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": [
@@ -177,7 +193,7 @@
               "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."
+          "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",
@@ -217,7 +233,12 @@
         },
         "projectId": {
           "type": "string",
-          "description": "Vercel project ID"
+          "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."
+        },
+        "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",