@vercel/microfrontends 0.9.0

package/schema/schema.json

@@ -0,0 +1,352 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/Config",
+  "definitions": {
+    "Config": {
+      "type": "object",
+      "properties": {
+        "version": {
+          "type": "string"
+        },
+        "$schema": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string",
+          "description": "Name for the micro-frontend site (eg. \"vercel.com\", \"vercel-site\" etc.)."
+        },
+        "applications": {
+          "$ref": "#/definitions/ApplicationConfigsById"
+        },
+        "options": {
+          "$ref": "#/definitions/Options",
+          "description": "Optional configuration for the entire micro-frontends setup."
+        }
+      },
+      "required": [
+        "version",
+        "applications"
+      ],
+      "description": "Configuration for micro-frontend applications\n\nTODO: Add proxy configuration"
+    },
+    "ApplicationConfigsById": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/ApplicationConfig"
+      }
+    },
+    "ApplicationConfig": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/DefaultApplicationConfig"
+        },
+        {
+          "$ref": "#/definitions/CommonApplicationConfig"
+        }
+      ],
+      "description": "A Micro-Frontend Deployment Target"
+    },
+    "DefaultApplicationConfig": {
+      "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"
+        },
+        "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"
+          ]
+        },
+        "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": {
+      "type": "object",
+      "properties": {
+        "assetPrefix": {
+          "type": "string",
+          "description": "[assetPrefix] for the application"
+        },
+        "matches": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PathGroup"
+          },
+          "description": "Path expressions that are routed to this application."
+        }
+      },
+      "required": [
+        "matches"
+      ]
+    },
+    "PathGroup": {
+      "type": "object",
+      "properties": {
+        "group": {
+          "type": "string",
+          "description": "Optional group name for the paths"
+        },
+        "options": {
+          "type": "object",
+          "properties": {
+            "flag": {
+              "type": "string",
+              "description": "flag name that can be used to enable/disable all paths in the group"
+            },
+            "routeToDefaultApplication": {
+              "type": "boolean",
+              "description": "True to route the request to the default application for this micro-frontends set-up. This must be `true` when using `flag` or when you want to use custom logic to make the routing decision for this group of paths."
+            }
+          }
+        },
+        "paths": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": [
+        "paths"
+      ]
+    },
+    "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* @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`)."
+        },
+        "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"
+        }
+      },
+      "required": [
+        "host"
+      ]
+    },
+    "Vercel": {
+      "type": "object",
+      "properties": {
+        "projectId": {
+          "type": "string",
+          "description": "Vercel project ID"
+        },
+        "projectName": {
+          "type": "string",
+          "description": "Vercel project name (temporary until we can use project ID)"
+        },
+        "defaultRoute": {
+          "type": "string",
+          "description": "The default route for the application. Used to render screenshots, favicons, and provide direct zone links"
+        },
+        "routeSpeedInsightsToDefaultZone": {
+          "type": "boolean",
+          "description": "Whether to route Speed Insights to the default zone or each individual microfrontend."
+        }
+      },
+      "required": [
+        "projectId"
+      ]
+    },
+    "CommonApplicationConfig": {
+      "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"
+        },
+        "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"
+          ]
+        },
+        "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"
+      ]
+    },
+    "Options": {
+      "type": "object",
+      "properties": {
+        "vercel": {
+          "$ref": "#/definitions/VercelOptions",
+          "description": "Micro-Frontends wide options for Vercel."
+        },
+        "localProxy": {
+          "$ref": "#/definitions/LocalProxyOptions",
+          "description": "Options for local proxy."
+        }
+      }
+    },
+    "VercelOptions": {
+      "type": "object",
+      "properties": {
+        "previewDeploymentSuffix": {
+          "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`."
+        },
+        "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."
+        }
+      }
+    },
+    "LocalProxyOptions": {
+      "type": "object",
+      "properties": {
+        "port": {
+          "type": "number",
+          "description": "The port number used by the local proxy server.\n\nThe default is `3024`."
+        }
+      }
+    }
+  }
+}