@vercel/microfrontends/dist/types-dcd8b17a.d.ts

Defines configuration and utilities for microfrontends development

/**
 * 👉 This file is used to generate the OpenAPI schema for the microfrontends configuration.
 * Any type in this file is displayed dynamically in https://vercel.com/docs/microfrontends/configuration 📚
 */
/**
 * The microfrontends configuration schema.
 * See https://vercel.com/docs/microfrontends/configuration.
 */
interface Config {
    /**
     * See https://openapi.vercel.sh/microfrontends.json.
     */
    $schema?: string;
    /**
     * The version of the microfrontends config schema.
     */
    version?: '1';
    /**
     * Mapping of Vercel project names to their microfrontend configurations.
     */
    applications: ApplicationRouting;
    /**
     * Optional configuration options for the microfrontend.
     */
    options?: Options;
}
/**
 * Mapping of Vercel project names to their microfrontend configurations.
 */
type ApplicationRouting = Record<ApplicationId, Application>;
/**
 * The Vercel project name of the microfrontend application.
 *
 * Note: If this name does not also match the name `name` from the `package.json`,
 * set `packageName` with the name used in `package.json`.
 *
 * See https://vercel.com/docs/microfrontends/configuration#application-naming.
 */
type ApplicationId = string;
/**
 * A list of path groups that are routed to this application.
 */
type Routing = PathGroup[];
/**
 * A group of paths that is routed to this application.
 */
interface PathGroup {
    /**
     * Group name for the paths.
     */
    group?: string;
    /**
     * The name of the feature flag that controls routing for this group of paths.
     * See https://vercel.com/docs/microfrontends/path-routing#routing-changes-safely-with-flags.
     */
    flag?: string;
    /**
     * A list of path expressions that are routed to this application.
     * See https://vercel.com/docs/microfrontends/path-routing#supported-path-expressions.
     */
    paths: string[];
}
interface CommonDevelopment {
    /**
     * A local port number or host that this application runs on when it is running locally.
     * If passing a string, include the protocol (optional), host (required) and port (optional).
     *
     * Examples of valid values: 8080, my.localhost.me, my.localhost.me:8080, https://my.localhost.me, https://my.localhost.me:8080.
     *
     * The default value is http://localhost:<port> where port is a stable, unique port number (based on the application name).
     *
     * See https://vercel.com/docs/microfrontends/local-development.
     */
    local?: number | string;
    /**
     * The task to run when starting the development server. Should reference a script in the package.json of the application.
     *
     * The default value is "dev".
     *
     * See https://vercel.com/docs/microfrontends/local-development.
     */
    task?: string;
}
interface DefaultDevelopment extends CommonDevelopment {
    /**
     * Fallback for local development, could point to any environment. This is required for the default
     * app. This value is used as the fallback for child apps as well if they do not have a fallback.
     *
     * 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 HTTPS. If
     * omitted, the port defaults to `80` for HTTP and `443` for HTTPS.
     *
     * See https://vercel.com/docs/microfrontends/local-development.
     */
    fallback: string;
}
interface ChildDevelopment extends CommonDevelopment {
    /**
     * Fallback for local development, could point to any environment. If not provided for child apps,
     * the fallback of the default app will be used.
     *
     * 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 HTTPS. If
     * omitted, the port defaults to `80` for HTTP and `443` for HTTPS.
     *
     * See https://vercel.com/docs/microfrontends/local-development.
     */
    fallback?: string;
}
/**
 * The configuration for a microfrontend application. There must always be one default application.
 */
type Application = DefaultApplication | ChildApplication;
interface CommonApplication {
    /**
     * The name used to run the application, e.g. the `name` field in the `package.json`.
     *
     * This is used by the local proxy to map the application config to the locally running app.
     *
     * This is only necessary when the application name does not match the `name` used in `package.json`.
     *
     * See https://vercel.com/docs/microfrontends/configuration#application-naming.
     */
    packageName?: string;
}
interface DefaultApplication extends CommonApplication {
    /**
     * Development configuration for the default application.
     */
    development: DefaultDevelopment;
}
interface ChildApplication extends CommonApplication {
    /**
     * Development configuration for the child application.
     */
    development?: ChildDevelopment;
    /**
     * Groups of path expressions that are routed to this application.
     *
     * See https://vercel.com/docs/microfrontends/path-routing.
     */
    routing: Routing;
    /**
     * The name of the asset prefix to use instead of the auto-generated name.
     *
     * The asset prefix is used to prefix all paths to static assets, such as JS, CSS, or images
     * that are served by a specific application. It is necessary to ensure there are no conflicts
     * with other applications on the same domain.
     *
     * An auto-generated asset prefix of the form `vc-ap-<hash>` is used when this field is not provided.
     *
     * When this field is provided, `/${assetPrefix}/:path*` must also be added to the
     * list of paths in the `routing` field. Changing the asset prefix after a microfrontend application
     * has already been deployed is not a forwards and backwards compatible change, and the asset prefix
     * should be added to the `routing` field and deployed before setting the `assetPrefix` field.
     *
     * The default value is the auto-generated asset prefix of the form `vc-ap-<hash>`.
     *
     * See https://vercel.com/docs/microfrontends/path-routing#asset-prefix.
     */
    assetPrefix?: string;
}
interface Options {
    /**
     * 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.
     *
     * See https://vercel.com/docs/microfrontends/managing-microfrontends/vercel-toolbar#routing-overrides.
     */
    disableOverrides?: boolean;
    /**
     * The port number used by the local proxy server.
     *
     * The default value is 3024.
     *
     * See https://vercel.com/docs/microfrontends/local-development.
     */
    localProxyPort?: number;
}

export { Application as A, Config as C, DefaultApplication as D, PathGroup as P, ApplicationId as a, ChildApplication as b };