@vercel/microfrontends 0.9.0

package/dist/schema-83a75e61.d.ts

@@ -0,0 +1,188 @@
+/**
+ * The unique identifier for a MicroFrontEnd Application.
+ * Must match the `name` field of the application's `package.json`.
+ */
+type ApplicationId = string;
+interface PathConfigurationOptions {
+    /**
+     * flag name that can be used to enable/disable all paths in the group
+     */
+    flag?: string;
+    /**
+     * 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.
+     */
+    routeToDefaultApplication?: boolean;
+}
+interface PathGroup {
+    /**
+     * Optional group name for the paths
+     */
+    group?: string;
+    options?: PathConfigurationOptions;
+    paths: string[];
+}
+interface HostConfig {
+    /**
+     * The protocol to be used for the connection.
+     * - `http`: Hypertext Transfer Protocol (HTTP).
+     * - `https`: Secure Hypertext Transfer Protocol (HTTPS).
+     *
+     * * @defaultValue "https"
+     */
+    protocol?: 'http' | 'https';
+    /**
+     * 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`).
+     */
+    host: string;
+    /**
+     * The port number to be used for the connection.
+     * Common values include `80` for HTTP and `443` for HTTPS.
+     *
+     * This field is optional and can be omitted if the default ports for the specified protocol are used
+     */
+    port?: number;
+}
+interface Development {
+    local: HostConfig;
+    /**
+     * 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.
+     */
+    fallback?: HostConfig;
+    /**
+     * Optional task to run when starting the development server. Should reference a script in the package.json of the application.
+     *
+     * @defaultValue "dev"
+     */
+    task?: string;
+}
+interface Vercel {
+    /**
+     * Vercel project ID
+     */
+    projectId: string;
+    /**
+     * Vercel project name (temporary until we can use project ID)
+     */
+    projectName?: string;
+    /**
+     * The default route for the application. Used to render screenshots, favicons, and provide direct zone links
+     */
+    defaultRoute?: string;
+    /**
+     * Whether to route Speed Insights to the default zone or each individual microfrontend.
+     */
+    routeSpeedInsightsToDefaultZone?: boolean;
+}
+interface Routing {
+    /**
+     * [assetPrefix] for the application
+     */
+    assetPrefix?: string;
+    /**
+     * Path expressions that are routed to this application.
+     */
+    matches: PathGroup[];
+}
+interface Module {
+    /**
+     * The name of the module - should be used when importing the module from another application
+     */
+    name: string;
+    /**
+     * Relative path to the module within its `application`
+     */
+    path: string;
+}
+interface Federation {
+    /**
+     * Modules that are exposed by this application
+     */
+    exposes?: Module[];
+    /**
+     * Modules that are used by this application. Only the name of the module is required.
+     */
+    uses?: string[];
+}
+interface ApplicationConfigCommon {
+    /**
+     * The default application is used no other application is matched via the routing config
+     */
+    default: boolean;
+    routing?: Routing;
+    development: Development;
+    production: HostConfig;
+    metadata?: Record<string, string>;
+    federation?: Federation;
+    vercel?: Vercel;
+}
+interface DefaultApplicationConfig extends ApplicationConfigCommon {
+    default: true;
+}
+interface CommonApplicationConfig extends ApplicationConfigCommon {
+    default: false;
+    routing: Routing;
+}
+/** A Micro-Frontend Deployment Target */
+type ApplicationConfig = DefaultApplicationConfig | CommonApplicationConfig;
+type ApplicationConfigsById = Record<ApplicationId, ApplicationConfig>;
+interface VercelOptions {
+    /**
+     * 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`.
+     */
+    previewDeploymentSuffix?: string;
+    /**
+     * Team slug for the Vercel team
+     */
+    teamSlug?: string;
+    /**
+     * 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.
+     */
+    disableOverrides?: boolean;
+}
+interface Options {
+    /**
+     * Micro-Frontends wide options for Vercel.
+     */
+    vercel?: VercelOptions;
+    /**
+     * Options for local proxy.
+     */
+    localProxy?: LocalProxyOptions;
+}
+interface LocalProxyOptions {
+    /**
+     * The port number used by the local proxy server.
+     *
+     * The default is `3024`.
+     */
+    port?: number;
+}
+/**
+ * Configuration for micro-frontend applications
+ *
+ * TODO: Add proxy configuration
+ */
+interface Config {
+    version: string;
+    $schema?: string;
+    /**
+     * Name for the micro-frontend site (eg. "vercel.com", "vercel-site" etc.).
+     */
+    name?: string;
+    applications: ApplicationConfigsById;
+    /**
+     * Optional configuration for the entire micro-frontends setup.
+     */
+    options?: Options;
+}
+
+export { ApplicationConfig as A, Config as C, DefaultApplicationConfig as D, HostConfig as H, Options as O, Routing as R, Vercel as V, CommonApplicationConfig as a };

package/dist/types-4fd1c7c6.d.ts

@@ -0,0 +1,157 @@
+type Config = MainConfig | ChildConfig;
+interface CommonConfig {
+    $schema?: string;
+    version: '2';
+    options?: Options;
+    /**
+     * 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.
+     */
+    remotes?: Record<ApplicationId, Application>;
+}
+interface MainConfig extends CommonConfig {
+    provider: Provider;
+    /**
+     * Mapping of application names to the routes that they host.
+     * Only needs to be defined in the application that owns the primary
+     * microfrontend domain
+     */
+    applications: ApplicationRouting;
+}
+interface ChildConfig extends CommonConfig {
+    /**
+     * 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: string;
+}
+type Provider = 'vercel' | 'other';
+type ApplicationRouting = Record<ApplicationId, Application>;
+/**
+ * The unique identifier for a MicroFrontEnd Application.
+ * Must match the `name` field of the application's `package.json`.
+ */
+type ApplicationId = string;
+type Routing = PathGroup[];
+interface PathGroup {
+    /**
+     * Optional group name for the paths
+     */
+    group?: string;
+    /**
+     * flag name that can be used to enable/disable all paths in the group
+     */
+    flag?: string;
+    /**
+     * 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.
+     */
+    routeToDefaultApplication?: boolean;
+    paths: string[];
+}
+interface HostConfig {
+    /**
+     * The protocol to be used for the connection.
+     * - `http`: Hypertext Transfer Protocol (HTTP).
+     * - `https`: Secure Hypertext Transfer Protocol (HTTPS).
+     *
+     * * @defaultValue "http" for local development, "https" for otherwise
+     */
+    protocol?: 'http' | 'https';
+    /**
+     * 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`).
+     */
+    host: string;
+    /**
+     * The port number to be used for the connection.
+     * Common values include `80` for HTTP and `443` for HTTPS.
+     *
+     */
+    port?: number;
+}
+type LocalHostConfig = Omit<HostConfig, 'host'> & {
+    /**
+     * 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`).
+     */
+    host?: string;
+};
+interface Development {
+    local?: LocalHostConfig;
+    /**
+     * 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.
+     */
+    fallback?: HostConfig;
+    /**
+     * Optional task to run when starting the development server. Should reference a script in the package.json of the application.
+     *
+     * @defaultValue "dev"
+     */
+    task?: string;
+}
+type Application = DefaultApplication | ChildApplication;
+interface CommonApplication {
+    vercel?: Vercel;
+    development?: Development;
+}
+interface DefaultApplication extends CommonApplication {
+    production: HostConfig;
+}
+interface ChildApplication extends CommonApplication {
+    /**
+     * Groups of path expressions that are routed to this application.
+     */
+    routing: Routing;
+    production?: HostConfig;
+}
+interface Vercel {
+    /**
+     * Vercel project ID
+     */
+    projectId: string;
+    routeSpeedInsightsToDefaultZone?: boolean;
+}
+interface VercelOptions {
+    /**
+     * 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`.
+     */
+    previewDeploymentSuffix?: string;
+    /**
+     * Team slug for the Vercel team
+     */
+    teamSlug?: string;
+    /**
+     * 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.
+     */
+    disableOverrides?: boolean;
+}
+interface Options {
+    /**
+     * Micro-Frontends wide options for Vercel.
+     */
+    vercel?: VercelOptions;
+    /**
+     * Options for local proxy.
+     */
+    localProxy?: LocalProxyOptions;
+}
+interface LocalProxyOptions {
+    /**
+     * The port number used by the local proxy server.
+     *
+     * The default is `3024`.
+     */
+    port?: number;
+}
+
+export { ApplicationId as A, Config as C, DefaultApplication as D, HostConfig as H, LocalHostConfig as L, MainConfig as M, Provider as P, Vercel as V, ChildConfig as a, PathGroup as b, ChildApplication as c, Application as d };