@module-federation/enhanced 0.0.7 → 0.0.9

package/dist/src/declarations/plugins/container/ModuleFederationPlugin.d.ts

@@ -0,0 +1,320 @@
+/*
+ * This file was automatically generated.
+ * DO NOT MODIFY BY HAND.
+ * Run `yarn special-lint-fix` to update
+ */
+
+/**
+ * Modules that should be exposed by this container. When provided, property name is used as public name, otherwise public name is automatically inferred from request.
+ */
+export type Exposes = (ExposesItem | ExposesObject)[] | ExposesObject;
+/**
+ * Module that should be exposed by this container.
+ */
+export type ExposesItem = string;
+/**
+ * Modules that should be exposed by this container.
+ */
+export type ExposesItems = ExposesItem[];
+/**
+ * Add a container for define/require functions in the AMD module.
+ */
+export type AmdContainer = string;
+/**
+ * Add a comment in the UMD wrapper.
+ */
+export type AuxiliaryComment = string | LibraryCustomUmdCommentObject;
+/**
+ * Specify which export should be exposed as library.
+ */
+export type LibraryExport = string[] | string;
+/**
+ * The name of the library (some types allow unnamed libraries too).
+ */
+export type LibraryName = string[] | string | LibraryCustomUmdObject;
+/**
+ * Type of library (types included by default are 'var', 'module', 'assign', 'assign-properties', 'this', 'window', 'self', 'global', 'commonjs', 'commonjs2', 'commonjs-module', 'commonjs-static', 'amd', 'amd-require', 'umd', 'umd2', 'jsonp', 'system', but others might be added by plugins).
+ */
+export type LibraryType =
+  | (
+      | 'var'
+      | 'module'
+      | 'assign'
+      | 'assign-properties'
+      | 'this'
+      | 'window'
+      | 'self'
+      | 'global'
+      | 'commonjs'
+      | 'commonjs2'
+      | 'commonjs-module'
+      | 'commonjs-static'
+      | 'amd'
+      | 'amd-require'
+      | 'umd'
+      | 'umd2'
+      | 'jsonp'
+      | 'system'
+    )
+  | string;
+/**
+ * If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module.
+ */
+export type UmdNamedDefine = boolean;
+/**
+ * Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value).
+ */
+export type ExternalsType =
+  | 'var'
+  | 'module'
+  | 'assign'
+  | 'this'
+  | 'window'
+  | 'self'
+  | 'global'
+  | 'commonjs'
+  | 'commonjs2'
+  | 'commonjs-module'
+  | 'commonjs-static'
+  | 'amd'
+  | 'amd-require'
+  | 'umd'
+  | 'umd2'
+  | 'jsonp'
+  | 'system'
+  | 'promise'
+  | 'import'
+  | 'script'
+  | 'node-commonjs';
+/**
+ * Container locations and request scopes from which modules should be resolved and loaded at runtime. When provided, property name is used as request scope, otherwise request scope is automatically inferred from container location.
+ */
+export type Remotes = (RemotesItem | RemotesObject)[] | RemotesObject;
+/**
+ * Container location from which modules should be resolved and loaded at runtime.
+ */
+export type RemotesItem = string;
+/**
+ * Container locations from which modules should be resolved and loaded at runtime.
+ */
+export type RemotesItems = RemotesItem[];
+/**
+ * The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
+ */
+export type EntryRuntime = false | string;
+/**
+ * Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
+ */
+export type Shared = (SharedItem | SharedObject)[] | SharedObject;
+/**
+ * A module that should be shared in the share scope.
+ */
+export type SharedItem = string;
+
+export interface ModuleFederationPluginOptions {
+  /**
+   * Modules that should be exposed by this container. When provided, property name is used as public name, otherwise public name is automatically inferred from request.
+   */
+  exposes?: Exposes;
+  /**
+   * The filename of the container as relative path inside the `output.path` directory.
+   */
+  filename?: string;
+  /**
+   * Options for library.
+   */
+  library?: LibraryOptions;
+  /**
+   * The name of the container.
+   */
+  name?: string;
+  /**
+   * The external type of the remote containers.
+   */
+  remoteType?: ExternalsType;
+  /**
+   * Container locations and request scopes from which modules should be resolved and loaded at runtime. When provided, property name is used as request scope, otherwise request scope is automatically inferred from container location.
+   */
+  remotes?: Remotes;
+  /**
+   * The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
+   */
+  runtime?: EntryRuntime;
+  /**
+   * Share scope name used for all shared modules (defaults to 'default').
+   */
+  shareScope?: string;
+  /**
+   * Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
+   */
+  shared?: Shared;
+  /**
+   * Runtime plugin file paths or package name.
+   */
+  runtimePlugins?: string[];
+  /**
+   * Bundler runtime path
+   */
+  implementation?: string;
+}
+/**
+ * Modules that should be exposed by this container. Property names are used as public paths.
+ */
+export interface ExposesObject {
+  /**
+   * Modules that should be exposed by this container.
+   */
+  [k: string]: ExposesConfig | ExposesItem | ExposesItems;
+}
+/**
+ * Advanced configuration for modules that should be exposed by this container.
+ */
+export interface ExposesConfig {
+  /**
+   * Request to a module that should be exposed by this container.
+   */
+  import: ExposesItem | ExposesItems;
+  /**
+   * Custom chunk name for the exposed module.
+   */
+  name?: string;
+}
+/**
+ * Options for library.
+ */
+export interface LibraryOptions {
+  /**
+   * Add a container for define/require functions in the AMD module.
+   */
+  amdContainer?: AmdContainer;
+  /**
+   * Add a comment in the UMD wrapper.
+   */
+  auxiliaryComment?: AuxiliaryComment;
+  /**
+   * Specify which export should be exposed as library.
+   */
+  export?: LibraryExport;
+  /**
+   * The name of the library (some types allow unnamed libraries too).
+   */
+  name?: LibraryName;
+  /**
+   * Type of library (types included by default are 'var', 'module', 'assign', 'assign-properties', 'this', 'window', 'self', 'global', 'commonjs', 'commonjs2', 'commonjs-module', 'commonjs-static', 'amd', 'amd-require', 'umd', 'umd2', 'jsonp', 'system', but others might be added by plugins).
+   */
+  type: LibraryType;
+  /**
+   * If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module.
+   */
+  umdNamedDefine?: UmdNamedDefine;
+}
+/**
+ * Set explicit comments for `commonjs`, `commonjs2`, `amd`, and `root`.
+ */
+export interface LibraryCustomUmdCommentObject {
+  /**
+   * Set comment for `amd` section in UMD.
+   */
+  amd?: string;
+  /**
+   * Set comment for `commonjs` (exports) section in UMD.
+   */
+  commonjs?: string;
+  /**
+   * Set comment for `commonjs2` (module.exports) section in UMD.
+   */
+  commonjs2?: string;
+  /**
+   * Set comment for `root` (global variable) section in UMD.
+   */
+  root?: string;
+}
+/**
+ * Description object for all UMD variants of the library name.
+ */
+export interface LibraryCustomUmdObject {
+  /**
+   * Name of the exposed AMD library in the UMD.
+   */
+  amd?: string;
+  /**
+   * Name of the exposed commonjs export in the UMD.
+   */
+  commonjs?: string;
+  /**
+   * Name of the property exposed globally by a UMD library.
+   */
+  root?: string[] | string;
+}
+/**
+ * Container locations from which modules should be resolved and loaded at runtime. Property names are used as request scopes.
+ */
+export interface RemotesObject {
+  /**
+   * Container locations from which modules should be resolved and loaded at runtime.
+   */
+  [k: string]: RemotesConfig | RemotesItem | RemotesItems;
+}
+/**
+ * Advanced configuration for container locations from which modules should be resolved and loaded at runtime.
+ */
+export interface RemotesConfig {
+  /**
+   * Container locations from which modules should be resolved and loaded at runtime.
+   */
+  external: RemotesItem | RemotesItems;
+  /**
+   * The name of the share scope shared with this remote.
+   */
+  shareScope?: string;
+}
+/**
+ * Modules that should be shared in the share scope. Property names are used to match requested modules in this compilation. Relative requests are resolved, module requests are matched unresolved, absolute paths will match resolved requests. A trailing slash will match all requests with this prefix. In this case shareKey must also have a trailing slash.
+ */
+export interface SharedObject {
+  /**
+   * Modules that should be shared in the share scope.
+   */
+  [k: string]: SharedConfig | SharedItem;
+}
+/**
+ * Advanced configuration for modules that should be shared in the share scope.
+ */
+export interface SharedConfig {
+  /**
+   * Include the provided and fallback module directly instead behind an async request. This allows to use this shared module in initial load too. All possible shared modules need to be eager too.
+   */
+  eager?: boolean;
+  /**
+   * Provided module that should be provided to share scope. Also acts as fallback module if no shared module is found in share scope or version isn't valid. Defaults to the property name.
+   */
+  import?: false | SharedItem;
+  /**
+   * Package name to determine required version from description file. This is only needed when package name can't be automatically determined from request.
+   */
+  packageName?: string;
+  /**
+   * Version requirement from module in share scope.
+   */
+  requiredVersion?: false | string;
+  /**
+   * Module is looked up under this key from the share scope.
+   */
+  shareKey?: string;
+  /**
+   * Share scope name.
+   */
+  shareScope?: string;
+  /**
+   * Allow only a single version of the shared module in share scope (disabled by default).
+   */
+  singleton?: boolean;
+  /**
+   * Do not accept shared module if version is not valid (defaults to yes, if local fallback module is available and shared module is not a singleton, otherwise no, has no effect if there is no required version specified).
+   */
+  strictVersion?: boolean;
+  /**
+   * Version of the provided module. Will replace lower matching versions, but not higher.
+   */
+  version?: false | string;
+}

package/dist/src/declarations/plugins/container/ObjectDeserializerContext.d.ts

@@ -0,0 +1,4 @@
+export type ObjectDeserializerContext = {
+  read: () => any;
+  setCircularReference: (arg0: any) => void;
+};

package/dist/src/declarations/plugins/container/StaticExportsDependency.d.ts

@@ -0,0 +1,28 @@
+export class StaticExportsDependency extends NullDependency {
+  /**
+   * @param {string[] | true} exports export names
+   * @param {boolean} canMangle true, if mangling exports names is allowed
+   */
+  constructor(exports: string[] | true, canMangle: boolean);
+  exports: true | string[];
+  canMangle: boolean;
+}
+declare namespace StaticExportsDependency {
+  export {
+    ChunkGraph,
+    ExportSpec,
+    ExportsSpec,
+    UpdateHashContext,
+    ModuleGraph,
+    ObjectDeserializerContext,
+    ObjectSerializerContext,
+    Hash,
+  };
+}
+import NullDependency = require('./NullDependency');
+type ChunkGraph = import('../ChunkGraph');
+type ExportSpec = import('./Dependency').ExportSpec;
+type ExportsSpec = import('./Dependency').ExportsSpec;
+type UpdateHashContext = import('./Dependency').UpdateHashContext;
+type ModuleGraph = import('../ModuleGraph');
+type Hash = import('../util/Hash');

package/dist/src/declarations/plugins/container/Template.d.ts

@@ -0,0 +1,198 @@
+export = Template;
+
+declare class Template {
+  /**
+   *
+   * @param {Function} fn a runtime function (.runtime.js) "template"
+   * @returns {string} the updated and normalized function string
+   */
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  static getFunctionContent(fn: Function): string;
+  /**
+   * @param {string} str the string converted to identifier
+   * @returns {string} created identifier
+   */
+  static toIdentifier(str: string): string;
+  /**
+   *
+   * @param {string} str string to be converted to commented in bundle code
+   * @returns {string} returns a commented version of string
+   */
+  static toComment(str: string): string;
+  /**
+   *
+   * @param {string} str string to be converted to "normal comment"
+   * @returns {string} returns a commented version of string
+   */
+  static toNormalComment(str: string): string;
+  /**
+   * @param {string} str string path to be normalized
+   * @returns {string} normalized bundle-safe path
+   */
+  static toPath(str: string): string;
+  /**
+   * @param {number} n number to convert to ident
+   * @returns {string} returns single character ident
+   */
+  static numberToIdentifier(n: number): string;
+  /**
+   * @param {number} n number to convert to ident
+   * @returns {string} returns single character ident
+   */
+  static numberToIdentifierContinuation(n: number): string;
+  /**
+   *
+   * @param {string | string[]} s string to convert to identity
+   * @returns {string} converted identity
+   */
+  static indent(s: string | string[]): string;
+  /**
+   *
+   * @param {string|string[]} s string to create prefix for
+   * @param {string} prefix prefix to compose
+   * @returns {string} returns new prefix string
+   */
+  static prefix(s: string | string[], prefix: string): string;
+  /**
+   *
+   * @param {string|string[]} str string or string collection
+   * @returns {string} returns a single string from array
+   */
+  static asString(str: string | string[]): string;
+  /**
+   * @typedef {Object} WithId
+   * @property {string|number} id
+   */
+  /**
+   * @param {WithId[]} modules a collection of modules to get array bounds for
+   * @returns {[number, number] | false} returns the upper and lower array bounds
+   * or false if not every module has a number based id
+   */
+  static getModulesArrayBounds(
+    modules: {
+      id: string | number;
+    }[],
+  ): [number, number] | false;
+  /**
+   * @param {ChunkRenderContext} renderContext render context
+   * @param {Module[]} modules modules to render (should be ordered by identifier)
+   * @param {function(Module): Source} renderModule function to render a module
+   * @param {string=} prefix applying prefix strings
+   * @returns {Source | null} rendered chunk modules in a Source object or null if no modules
+   */
+  static renderChunkModules(
+    renderContext: ChunkRenderContext,
+    modules: Module[],
+    renderModule: (arg0: Module) => Source,
+    prefix?: string | undefined,
+  ): Source | null;
+  /**
+   * @param {RuntimeModule[]} runtimeModules array of runtime modules in order
+   * @param {RenderContext & { codeGenerationResults?: CodeGenerationResults }} renderContext render context
+   * @returns {Source} rendered runtime modules in a Source object
+   */
+  static renderRuntimeModules(
+    runtimeModules: RuntimeModule[],
+    renderContext: RenderContext & {
+      codeGenerationResults?: CodeGenerationResults;
+    },
+  ): Source;
+  /**
+   * @param {RuntimeModule[]} runtimeModules array of runtime modules in order
+   * @param {RenderContext} renderContext render context
+   * @returns {Source} rendered chunk runtime modules in a Source object
+   */
+  static renderChunkRuntimeModules(
+    runtimeModules: RuntimeModule[],
+    renderContext: RenderContext,
+  ): Source;
+}
+declare namespace Template {
+  export {
+    NUMBER_OF_IDENTIFIER_START_CHARS,
+    NUMBER_OF_IDENTIFIER_CONTINUATION_CHARS,
+    Source,
+    OutputOptions,
+    Chunk,
+    ChunkGraph,
+    CodeGenerationResults,
+    AssetInfo,
+    PathData,
+    DependencyTemplates,
+    Module,
+    ModuleGraph,
+    ModuleTemplate,
+    RuntimeModule,
+    RuntimeTemplate,
+    ChunkRenderContext,
+    RenderContext,
+    RenderManifestOptions,
+    RenderManifestEntry,
+    RenderManifestEntryTemplated,
+    RenderManifestEntryStatic,
+    HasId,
+    ModuleFilterPredicate,
+  };
+}
+type ChunkRenderContext =
+  import('./javascript/JavascriptModulesPlugin').ChunkRenderContext;
+type Module = import('./Module');
+type Source = import('webpack-sources').Source;
+type RuntimeModule = import('./RuntimeModule');
+type RenderContext =
+  import('./javascript/JavascriptModulesPlugin').RenderContext;
+type CodeGenerationResults = import('./CodeGenerationResults');
+declare const NUMBER_OF_IDENTIFIER_START_CHARS: number;
+declare const NUMBER_OF_IDENTIFIER_CONTINUATION_CHARS: number;
+type OutputOptions = import('../declarations/WebpackOptions').Output;
+type Chunk = import('./Chunk');
+type ChunkGraph = import('./ChunkGraph');
+type AssetInfo = import('./Compilation').AssetInfo;
+type PathData = import('./Compilation').PathData;
+type DependencyTemplates = import('./DependencyTemplates');
+type ModuleGraph = import('./ModuleGraph');
+type ModuleTemplate = import('./ModuleTemplate');
+type RuntimeTemplate = import('./RuntimeTemplate');
+type RenderManifestOptions = {
+  /**
+   * the chunk used to render
+   */
+  chunk: Chunk;
+  hash: string;
+  fullHash: string;
+  outputOptions: OutputOptions;
+  codeGenerationResults: CodeGenerationResults;
+  moduleTemplates: {
+    javascript: ModuleTemplate;
+  };
+  dependencyTemplates: DependencyTemplates;
+  runtimeTemplate: RuntimeTemplate;
+  moduleGraph: ModuleGraph;
+  chunkGraph: ChunkGraph;
+};
+type RenderManifestEntry =
+  | RenderManifestEntryTemplated
+  | RenderManifestEntryStatic;
+type RenderManifestEntryTemplated = {
+  render: () => Source;
+  filenameTemplate:
+    | string
+    | ((arg0: PathData, arg1: AssetInfo | undefined) => string);
+  pathOptions?: PathData | undefined;
+  info?: AssetInfo | undefined;
+  identifier: string;
+  hash?: string | undefined;
+  auxiliary?: boolean | undefined;
+};
+type RenderManifestEntryStatic = {
+  render: () => Source;
+  filename: string;
+  info: AssetInfo;
+  identifier: string;
+  hash?: string | undefined;
+  auxiliary?: boolean | undefined;
+};
+type HasId = {
+  id: number | string;
+};
+type ModuleFilterPredicate = (arg0: Module, arg1: number) => boolean;

package/dist/src/declarations/plugins/container/WebpackError.d.ts

@@ -0,0 +1,32 @@
+declare class WebpackError extends Error {
+  /**
+   * Creates an instance of WebpackError.
+   */
+  constructor(message?: string);
+  details?: string;
+  module?: null | Module;
+  loc?: SyntheticDependencyLocation | RealDependencyLocation;
+  hideStack?: boolean;
+  chunk?: Chunk;
+  file?: string;
+  serialize(__0: ObjectSerializerContext): void;
+  deserialize(__0: ObjectDeserializerContext): void;
+
+  /**
+   * Create .stack property on a target object
+   */
+  static captureStackTrace(
+    targetObject: object,
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    constructorOpt?: Function,
+  ): void;
+
+  /**
+   * Optional override for formatting stack traces
+   */
+  static prepareStackTrace?: (
+    err: Error,
+    stackTraces: NodeJS.CallSite[],
+  ) => any;
+  static stackTraceLimit: number;
+}