@fulgurjs/federation 4.3.0 → 5.0.0

package/dist/index.d.cts

@@ -1,6 +1,91 @@
 import { Plugin } from 'vite';
-import { F as FederationOptions } from './options-CRGpSmVj.cjs';
+
+interface SharedHint {
+    /** 放入共享作用域的本地模块；false 表示不提供本地副本 */
+    import?: string | false;
+    /** 用于从 package.json 推断 requiredVersion 的包名 */
+    packageName?: string;
+    /** 期望版本（完整 semver 语法 / false 接受任意） */
+    requiredVersion?: string | false;
+    /** 只允许单实例 */
+    singleton?: boolean;
+    /** 版本无效时抛运行时错误（默认：有本地副本且非 singleton 时为 true，对齐 webpack） */
+    strictVersion?: boolean;
+    /** 在共享作用域中的键（导入名与共享名不同时使用） */
+    shareKey?: string;
+    /** 共享作用域命名空间 */
+    shareScope?: string;
+    /** 同步提供（打进初始 chunk，总是被下载） */
+    eager?: boolean;
+    /** 提供版本显式指定 */
+    version?: string;
+}
+type SharedConfig = string[] | Record<string, string | SharedHint>;
+interface ExposeHint {
+    import: string;
+    /** 稳定 chunk 文件名（不写则内部 id，随构建变化） */
+    name?: string;
+}
+interface RemoteEntryConfig {
+    external?: string;
+    shareScope?: string;
+    /** dev 专用地址（缺省回落 external） */
+    dev?: string;
+    /** prod 专用地址（缺省回落 external） */
+    prod?: string;
+    timeout?: number;
+    retries?: number;
+    /** 备用 remoteEntry 地址 */
+    fallback?: string[];
+    breaker?: {
+        threshold?: number;
+        resetMs?: number;
+    };
+}
+interface FederationOptions {
+    name: string;
+    filename?: string;
+    exposes?: Record<string, string | ExposeHint>;
+    /**
+     * 可选远程初始化入口：相对本应用根目录的 TS/JS 模块路径。
+     * 模块须默认导出 `setup(context)`（应用级，容器首次加载业务模块前执行一次），
+     * 可选具名导出 `onSession(context)`（会话级，按宿主 AppContext.sessionKey 去重执行）。
+     * 缺省时无初始化行为（普通 exposes 语义完全不变）。
+     */
+    setup?: string;
+    remotes?: Record<string, string | RemoteEntryConfig | (() => Promise<any>)>;
+    shared?: SharedConfig;
+    shareScope?: string;
+    runtime?: string | false;
+    runtimeChunk?: boolean | 'single';
+    manifest?: boolean | Record<string, unknown>;
+    runtimePlugins?: string[];
+    dts?: boolean | {
+        dir?: string;
+        mode?: 'source' | 'shim';
+    };
+    /**
+     * dev 下自身源码（含依赖，需配合 optimizeDeps.exclude）是否参与 shared 协商改写。
+     * 默认：纯 remote（无 remotes）为 true——被宿主消费的组件需协商到宿主实例；
+     * 有 remotes 的宿主为 false——自身 import 即自身 provide，避免巨型工程 TLA/循环依赖风险。
+     * 双向联邦（宿主同时 expose 组件给更高层消费）显式设 true。
+     */
+    devSharedSelf?: boolean;
+    /**
+     * dev 跨源访问策略（插件端点 /@fulgurjs-entry.js、/@fulgurjs-manifest.json 与 server.cors
+     * 共用同一来源）。缺省 = '*'（现状兼容：端点与 server.cors 全放开）；'*' = 显式全放开（不告警）；
+     * 数组 = 来源 allowlist（端点按 Origin 反射匹配，不匹配省略头；server.cors 传 { origin: [...] }，
+     * 用户显式配置的 server.cors 永远优先）。
+     */
+    devCorsOrigins?: string[] | '*';
+    /**
+     * dev manifest 是否携带 fsRoot（remote 根目录本机绝对路径，宿主 dts 类型直连用）。
+     * 默认 true（现状兼容）；false 时不写入 manifest，宿主 dts 降级为 any 桩并给出提示。
+     * fsRoot 是 dev-only 字段，永不进入 prod manifest。
+     */
+    devFsRoot?: boolean;
+}
 
 declare function federation(options: FederationOptions): Plugin[];
 
-export { FederationOptions, federation as default, federation };
+export { type FederationOptions, federation as default, federation };

package/dist/index.d.ts

@@ -1,6 +1,91 @@
 import { Plugin } from 'vite';
-import { F as FederationOptions } from './options-CRGpSmVj.js';
+
+interface SharedHint {
+    /** 放入共享作用域的本地模块；false 表示不提供本地副本 */
+    import?: string | false;
+    /** 用于从 package.json 推断 requiredVersion 的包名 */
+    packageName?: string;
+    /** 期望版本（完整 semver 语法 / false 接受任意） */
+    requiredVersion?: string | false;
+    /** 只允许单实例 */
+    singleton?: boolean;
+    /** 版本无效时抛运行时错误（默认：有本地副本且非 singleton 时为 true，对齐 webpack） */
+    strictVersion?: boolean;
+    /** 在共享作用域中的键（导入名与共享名不同时使用） */
+    shareKey?: string;
+    /** 共享作用域命名空间 */
+    shareScope?: string;
+    /** 同步提供（打进初始 chunk，总是被下载） */
+    eager?: boolean;
+    /** 提供版本显式指定 */
+    version?: string;
+}
+type SharedConfig = string[] | Record<string, string | SharedHint>;
+interface ExposeHint {
+    import: string;
+    /** 稳定 chunk 文件名（不写则内部 id，随构建变化） */
+    name?: string;
+}
+interface RemoteEntryConfig {
+    external?: string;
+    shareScope?: string;
+    /** dev 专用地址（缺省回落 external） */
+    dev?: string;
+    /** prod 专用地址（缺省回落 external） */
+    prod?: string;
+    timeout?: number;
+    retries?: number;
+    /** 备用 remoteEntry 地址 */
+    fallback?: string[];
+    breaker?: {
+        threshold?: number;
+        resetMs?: number;
+    };
+}
+interface FederationOptions {
+    name: string;
+    filename?: string;
+    exposes?: Record<string, string | ExposeHint>;
+    /**
+     * 可选远程初始化入口：相对本应用根目录的 TS/JS 模块路径。
+     * 模块须默认导出 `setup(context)`（应用级，容器首次加载业务模块前执行一次），
+     * 可选具名导出 `onSession(context)`（会话级，按宿主 AppContext.sessionKey 去重执行）。
+     * 缺省时无初始化行为（普通 exposes 语义完全不变）。
+     */
+    setup?: string;
+    remotes?: Record<string, string | RemoteEntryConfig | (() => Promise<any>)>;
+    shared?: SharedConfig;
+    shareScope?: string;
+    runtime?: string | false;
+    runtimeChunk?: boolean | 'single';
+    manifest?: boolean | Record<string, unknown>;
+    runtimePlugins?: string[];
+    dts?: boolean | {
+        dir?: string;
+        mode?: 'source' | 'shim';
+    };
+    /**
+     * dev 下自身源码（含依赖，需配合 optimizeDeps.exclude）是否参与 shared 协商改写。
+     * 默认：纯 remote（无 remotes）为 true——被宿主消费的组件需协商到宿主实例；
+     * 有 remotes 的宿主为 false——自身 import 即自身 provide，避免巨型工程 TLA/循环依赖风险。
+     * 双向联邦（宿主同时 expose 组件给更高层消费）显式设 true。
+     */
+    devSharedSelf?: boolean;
+    /**
+     * dev 跨源访问策略（插件端点 /@fulgurjs-entry.js、/@fulgurjs-manifest.json 与 server.cors
+     * 共用同一来源）。缺省 = '*'（现状兼容：端点与 server.cors 全放开）；'*' = 显式全放开（不告警）；
+     * 数组 = 来源 allowlist（端点按 Origin 反射匹配，不匹配省略头；server.cors 传 { origin: [...] }，
+     * 用户显式配置的 server.cors 永远优先）。
+     */
+    devCorsOrigins?: string[] | '*';
+    /**
+     * dev manifest 是否携带 fsRoot（remote 根目录本机绝对路径，宿主 dts 类型直连用）。
+     * 默认 true（现状兼容）；false 时不写入 manifest，宿主 dts 降级为 any 桩并给出提示。
+     * fsRoot 是 dev-only 字段，永不进入 prod manifest。
+     */
+    devFsRoot?: boolean;
+}
 
 declare function federation(options: FederationOptions): Plugin[];
 
-export { FederationOptions, federation as default, federation };
+export { type FederationOptions, federation as default, federation };