@module-federation/vite 1.11.0 → 1.12.0

package/lib/index.d.cts

@@ -0,0 +1,131 @@
+import { Plugin } from "vite";
+import { ShareStrategy } from "@module-federation/runtime/types";
+import { sharePlugin } from "@module-federation/sdk";
+
+//#region src/utils/normalizeModuleFederationOptions.d.ts
+interface RemoteObjectConfig {
+  type?: string;
+  name: string;
+  entry: string;
+  entryGlobalName?: string;
+  shareScope?: string;
+}
+interface ManifestOptions {
+  filePath?: string;
+  disableAssetsAnalyze?: boolean;
+  fileName?: string;
+}
+type ModuleFederationOptions = {
+  exposes?: Record<string, string | {
+    import: string;
+  }> | undefined;
+  filename?: string;
+  library?: any;
+  name: string;
+  remotes?: Record<string, string | RemoteObjectConfig> | undefined;
+  runtime?: any;
+  shareScope?: string;
+  /**
+   * Override the public path used for remote entries
+   * Defaults to Vite's base config or "auto" if base is empty
+   */
+  publicPath?: string;
+  /**
+   * Controls whether all CSS assets from the bundle should be added to every exposed module.
+   * When false (default), the plugin will not process any CSS assets.
+   * When true, all CSS assets are bundled into every exposed module.
+   */
+  bundleAllCSS?: boolean;
+  shared?: string[] | Record<string, string | {
+    name?: string;
+    version?: string;
+    shareScope?: string;
+    singleton?: boolean;
+    requiredVersion?: string;
+    strictVersion?: boolean;
+    import?: sharePlugin.SharedConfig['import'];
+  }> | undefined;
+  runtimePlugins?: Array<string | [string, Record<string, unknown>]>;
+  getPublicPath?: string;
+  implementation?: string;
+  manifest?: ManifestOptions | boolean;
+  dev?: boolean | PluginDevOptions;
+  dts?: boolean | PluginDtsOptions;
+  shareStrategy?: ShareStrategy;
+  ignoreOrigin?: boolean;
+  virtualModuleDir?: string;
+  hostInitInjectLocation?: HostInitInjectLocationOptions;
+  /**
+   * Timeout for parsing modules in seconds.
+   * Defaults to 10 seconds.
+   */
+  moduleParseTimeout?: number;
+  /**
+   * Allows generate additional remoteEntry file for "var" host environment
+   */
+  varFilename?: string;
+  /**
+   * Target environment for the build to enable effective tree-shaking.
+   *
+   * @see https://module-federation.io/configure/experiments#target
+   * @default 'web' (or 'node' if build.ssr is enabled)
+   */
+  target?: 'web' | 'node';
+};
+type HostInitInjectLocationOptions = 'entry' | 'html';
+interface PluginDevOptions {
+  disableLiveReload?: boolean;
+  disableHotTypesReload?: boolean;
+  disableDynamicRemoteTypeHints?: boolean;
+}
+interface RemoteTypeUrl {
+  alias?: string;
+  api: string;
+  zip: string;
+}
+interface RemoteTypeUrls {
+  [remoteName: string]: RemoteTypeUrl;
+}
+interface PluginDtsOptions {
+  generateTypes?: boolean | DtsRemoteOptions;
+  consumeTypes?: boolean | DtsHostOptions;
+  tsConfigPath?: string;
+  extraOptions?: Record<string, unknown>;
+  implementation?: string;
+  cwd?: string;
+  displayErrorInTerminal?: boolean;
+}
+interface DtsRemoteOptions {
+  tsConfigPath?: string;
+  typesFolder?: string;
+  compiledTypesFolder?: string;
+  deleteTypesFolder?: boolean;
+  additionalFilesToCompile?: string[];
+  compilerInstance?: 'tsc' | 'vue-tsc' | 'tspc' | string;
+  compileInChildProcess?: boolean;
+  generateAPITypes?: boolean;
+  extractThirdParty?: boolean | {
+    exclude?: Array<string | RegExp>;
+  };
+  extractRemoteTypes?: boolean;
+  abortOnError?: boolean;
+  deleteTsConfig?: boolean;
+}
+interface DtsHostOptions {
+  typesFolder?: string;
+  abortOnError?: boolean;
+  remoteTypesFolder?: string;
+  deleteTypesFolder?: boolean;
+  maxRetries?: number;
+  consumeAPITypes?: boolean;
+  runtimePkgs?: string[];
+  remoteTypeUrls?: (() => Promise<RemoteTypeUrls>) | RemoteTypeUrls;
+  timeout?: number;
+  family?: 4 | 6;
+  typesOnBuild?: boolean;
+}
+//#endregion
+//#region src/index.d.ts
+declare function federation(mfUserOptions: ModuleFederationOptions): Plugin[];
+//#endregion
+export { federation };

package/lib/index.d.mts

@@ -0,0 +1,131 @@
+import { sharePlugin } from "@module-federation/sdk";
+import { Plugin } from "vite";
+import { ShareStrategy } from "@module-federation/runtime/types";
+
+//#region src/utils/normalizeModuleFederationOptions.d.ts
+interface RemoteObjectConfig {
+  type?: string;
+  name: string;
+  entry: string;
+  entryGlobalName?: string;
+  shareScope?: string;
+}
+interface ManifestOptions {
+  filePath?: string;
+  disableAssetsAnalyze?: boolean;
+  fileName?: string;
+}
+type ModuleFederationOptions = {
+  exposes?: Record<string, string | {
+    import: string;
+  }> | undefined;
+  filename?: string;
+  library?: any;
+  name: string;
+  remotes?: Record<string, string | RemoteObjectConfig> | undefined;
+  runtime?: any;
+  shareScope?: string;
+  /**
+   * Override the public path used for remote entries
+   * Defaults to Vite's base config or "auto" if base is empty
+   */
+  publicPath?: string;
+  /**
+   * Controls whether all CSS assets from the bundle should be added to every exposed module.
+   * When false (default), the plugin will not process any CSS assets.
+   * When true, all CSS assets are bundled into every exposed module.
+   */
+  bundleAllCSS?: boolean;
+  shared?: string[] | Record<string, string | {
+    name?: string;
+    version?: string;
+    shareScope?: string;
+    singleton?: boolean;
+    requiredVersion?: string;
+    strictVersion?: boolean;
+    import?: sharePlugin.SharedConfig['import'];
+  }> | undefined;
+  runtimePlugins?: Array<string | [string, Record<string, unknown>]>;
+  getPublicPath?: string;
+  implementation?: string;
+  manifest?: ManifestOptions | boolean;
+  dev?: boolean | PluginDevOptions;
+  dts?: boolean | PluginDtsOptions;
+  shareStrategy?: ShareStrategy;
+  ignoreOrigin?: boolean;
+  virtualModuleDir?: string;
+  hostInitInjectLocation?: HostInitInjectLocationOptions;
+  /**
+   * Timeout for parsing modules in seconds.
+   * Defaults to 10 seconds.
+   */
+  moduleParseTimeout?: number;
+  /**
+   * Allows generate additional remoteEntry file for "var" host environment
+   */
+  varFilename?: string;
+  /**
+   * Target environment for the build to enable effective tree-shaking.
+   *
+   * @see https://module-federation.io/configure/experiments#target
+   * @default 'web' (or 'node' if build.ssr is enabled)
+   */
+  target?: 'web' | 'node';
+};
+type HostInitInjectLocationOptions = 'entry' | 'html';
+interface PluginDevOptions {
+  disableLiveReload?: boolean;
+  disableHotTypesReload?: boolean;
+  disableDynamicRemoteTypeHints?: boolean;
+}
+interface RemoteTypeUrl {
+  alias?: string;
+  api: string;
+  zip: string;
+}
+interface RemoteTypeUrls {
+  [remoteName: string]: RemoteTypeUrl;
+}
+interface PluginDtsOptions {
+  generateTypes?: boolean | DtsRemoteOptions;
+  consumeTypes?: boolean | DtsHostOptions;
+  tsConfigPath?: string;
+  extraOptions?: Record<string, unknown>;
+  implementation?: string;
+  cwd?: string;
+  displayErrorInTerminal?: boolean;
+}
+interface DtsRemoteOptions {
+  tsConfigPath?: string;
+  typesFolder?: string;
+  compiledTypesFolder?: string;
+  deleteTypesFolder?: boolean;
+  additionalFilesToCompile?: string[];
+  compilerInstance?: 'tsc' | 'vue-tsc' | 'tspc' | string;
+  compileInChildProcess?: boolean;
+  generateAPITypes?: boolean;
+  extractThirdParty?: boolean | {
+    exclude?: Array<string | RegExp>;
+  };
+  extractRemoteTypes?: boolean;
+  abortOnError?: boolean;
+  deleteTsConfig?: boolean;
+}
+interface DtsHostOptions {
+  typesFolder?: string;
+  abortOnError?: boolean;
+  remoteTypesFolder?: string;
+  deleteTypesFolder?: boolean;
+  maxRetries?: number;
+  consumeAPITypes?: boolean;
+  runtimePkgs?: string[];
+  remoteTypeUrls?: (() => Promise<RemoteTypeUrls>) | RemoteTypeUrls;
+  timeout?: number;
+  family?: 4 | 6;
+  typesOnBuild?: boolean;
+}
+//#endregion
+//#region src/index.d.ts
+declare function federation(mfUserOptions: ModuleFederationOptions): Plugin[];
+//#endregion
+export { federation };