@vercel/microfrontends 0.14.0 → 0.15.0

package/dist/microfrontend-config-983a5139.d.ts

@@ -1,154 +0,0 @@
-import { H as HostConfig, C as Config, R as Routing, V as Vercel, A as ApplicationConfig, O as Options } from './schema-2922d49e.js';
-
-interface ApplicationOverrideConfig {
-    environment?: HostConfig;
-}
-/**
- * Used to override the configuration for the application zone at runtime.
- * The configuration is used by the `vercel-micro-frontends-overrides` cookie set by the Vercel Toolbar.
- * The overrides config has the same shape as the `Config` type.
- */
-interface OverridesConfig {
-    applications: Record<keyof Config['applications'], ApplicationOverrideConfig>;
-}
-
-declare const OVERRIDES_COOKIE_PREFIX = "vercel-micro-frontends-override";
-declare class Overrides {
-    config: OverridesConfig;
-    constructor(config: OverridesConfig);
-    static overrideEnvCookiePrefix: string;
-    static getAppEnvOverrideCookieName(zone: string): string;
-    static isOverrideCookie(cookie: {
-        name?: string;
-    }): boolean;
-    static getOverrideFromCookie(cookie: {
-        name: string;
-        value?: string | null;
-    }): {
-        zone: string;
-        host: string;
-    } | undefined;
-    static parseOverrides(cookies: {
-        name: string;
-        value?: string | null;
-    }[]): OverridesConfig;
-    static validOverrideDomainsForZone(microfrontendConfig: MicrofrontendConfig, zone: string): string[];
-    static validateOverrideDomain(microfrontendConfig: MicrofrontendConfig, zone: string, domain: string): boolean;
-    serialize(): OverridesConfig;
-}
-
-interface HostDisplayOptions {
-    includeDefaultPort?: boolean;
-}
-declare class Host {
-    protocol: 'http' | 'https';
-    host: HostConfig['host'];
-    port: number;
-    serialized: HostConfig;
-    constructor({ protocol, host, port }: HostConfig);
-    isLocal(): boolean;
-    static getPort({ protocol, port, }: {
-        protocol: HostConfig['protocol'];
-        port?: HostConfig['port'];
-    }): number;
-    isDefaultPort(): boolean;
-    toString(opts?: HostDisplayOptions): string;
-    toUrl(opts?: HostDisplayOptions): URL;
-    serialize(): HostConfig;
-}
-
-declare class Application {
-    default: boolean;
-    routing?: Routing;
-    name: string;
-    development: {
-        local: Host;
-        fallback?: Host;
-    };
-    production: Host;
-    vercel?: Vercel;
-    overrides?: {
-        environment?: Host;
-    };
-    constructor(name: string, { app, overrides, }: {
-        app: ApplicationConfig;
-        overrides?: ApplicationOverrideConfig;
-    });
-    isDefault(): boolean;
-    static validate(name: string, app: ApplicationConfig): void;
-    serialize(): ApplicationConfig;
-}
-
-/**
- * A class to manage the microfrontends configuration.
- *
- * This class should not be used directly. Instead, use the `MicrofrontendConfig` or `MicrofrontendConfigEdgeRuntime` classes.
- */
-declare class MicrofrontendConfigCommon {
-    config: Config;
-    name?: string;
-    zones: Record<string, Application>;
-    version: string;
-    overrides?: Overrides;
-    options?: Options;
-    $schema: string | undefined;
-    constructor({ config, overrides, }: {
-        config: Config;
-        overrides?: OverridesConfig;
-    });
-    isOverridesDisabled(): boolean;
-    protected static getConfigFromEnv(): string;
-    static fromEnv(_: {
-        cookies: {
-            name: string;
-            value: string;
-        }[];
-    }): MicrofrontendConfigCommon | Promise<MicrofrontendConfigCommon>;
-    getConfig(): Config;
-    getAllApplications(): Application[];
-    getZone(name: string): Application;
-    getApplicationByProjectId(projectId: string): Application | undefined;
-    getDefaultZone(): Application;
-    /**
-     * Returns the configured port for the local proxy
-     */
-    getLocalProxyPort(): number;
-    /**
-     * Serializes the class back to the Schema type.
-     *
-     * NOTE: This is used when writing the config to disk and must always match the input Schema
-     */
-    toSchemaJson(): Config;
-    serialize(): {
-        config: Config;
-        overrides?: OverridesConfig;
-    };
-    write(_: string): void;
-}
-
-/**
- * A class to manage the microfrontends configuration with config validation.
- *
- * Cannot be used by the middleware which runs in the Edge Runtime. For middleware use `MicrofrontendConfigEdgeRuntime`.
- */
-declare class MicrofrontendConfig extends MicrofrontendConfigCommon {
-    static validate(configString: string): Config;
-    static fromEnv({ cookies, }: {
-        cookies: {
-            name: string;
-            value: string;
-        }[];
-    }): MicrofrontendConfig;
-    static fromFile({ filePath, }: {
-        filePath: string;
-    }): MicrofrontendConfig;
-    /**
-     * Writes the configuration to a file.
-     */
-    write(fromApp: string, opts?: {
-        pretty?: boolean;
-        versions?: ('v1' | 'v2')[];
-    }): void;
-}
-
-export { ApplicationOverrideConfig as A, MicrofrontendConfig as M, OverridesConfig as O, MicrofrontendConfigCommon as a, OVERRIDES_COOKIE_PREFIX as b, Overrides as c };

package/dist/schema-2922d49e.d.ts

@@ -1,182 +0,0 @@
-/**
- * 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;
-}
-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 };