@module-federation/sdk 0.0.0-next-20240227135200 → 0.0.0-next-20240228024935

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs.js CHANGED
@@ -29,29 +29,6 @@ var NameTransformMap = (_obj = {}, _define_property$2(_obj, NameTransformSymbol.
29
29
  var _obj1;
30
30
  var EncodedNameTransformMap = (_obj1 = {}, _define_property$2(_obj1, NameTransformMap[NameTransformSymbol.AT], NameTransformSymbol.AT), _define_property$2(_obj1, NameTransformMap[NameTransformSymbol.HYPHEN], NameTransformSymbol.HYPHEN), _define_property$2(_obj1, NameTransformMap[NameTransformSymbol.SLASH], NameTransformSymbol.SLASH), _obj1);
31
31
  var SEPARATOR = ":";
32
- var ManifestFileName = "mf-manifest.json";
33
- var StatsFileName = "mf-stats.json";
34
- exports.ModuleType = void 0;
35
- (function(ModuleType) {
36
- ModuleType["NPM"] = "npm";
37
- ModuleType["APP"] = "app";
38
- })(exports.ModuleType || (exports.ModuleType = {}));
39
-
40
- var ContainerPlugin = /*#__PURE__*/Object.freeze({
41
- __proto__: null
42
- });
43
-
44
- var ContainerReferencePlugin = /*#__PURE__*/Object.freeze({
45
- __proto__: null
46
- });
47
-
48
- var ModuleFederationPlugin = /*#__PURE__*/Object.freeze({
49
- __proto__: null
50
- });
51
-
52
- var SharePlugin = /*#__PURE__*/Object.freeze({
53
- __proto__: null
54
- });
55
32
 
56
33
  function isBrowserEnv() {
57
34
  return typeof window !== "undefined";
@@ -131,13 +108,23 @@ function safeToString(info) {
131
108
  }
132
109
  }
133
110
  var DEBUG_LOG = "[ FEDERATION DEBUG ]";
111
+ function safeGetLocalStorageItem() {
112
+ try {
113
+ if (typeof window !== "undefined" && window.localStorage) {
114
+ return localStorage.getItem(BROWSER_LOG_KEY) === BROWSER_LOG_VALUE;
115
+ }
116
+ } catch (error) {
117
+ return typeof document !== "undefined";
118
+ }
119
+ return false;
120
+ }
134
121
  var Logger = /*#__PURE__*/ function() {
135
122
  function Logger(identifier) {
136
123
  _class_call_check(this, Logger);
137
124
  _define_property$1(this, "enable", false);
138
125
  _define_property$1(this, "identifier", void 0);
139
126
  this.identifier = identifier || DEBUG_LOG;
140
- if (isBrowserEnv() && localStorage.getItem(BROWSER_LOG_KEY) === BROWSER_LOG_VALUE) {
127
+ if (isBrowserEnv() && safeGetLocalStorageItem()) {
141
128
  this.enable = true;
142
129
  } else if (isDebugMode()) {
143
130
  this.enable = true;
@@ -236,8 +223,7 @@ var LOG_CATEGORY = "[ Federation Runtime ]";
236
223
  // entry: name:version version : 1.0.0 | ^1.2.3
237
224
  // entry: name:entry entry: https://localhost:9000/federation-manifest.json
238
225
  var parseEntry = function(str, devVerOrUrl) {
239
- var separator = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : SEPARATOR;
240
- var strSplit = str.split(separator);
226
+ var strSplit = str.split(SEPARATOR);
241
227
  var devVersionOrUrl = getProcessEnv()["NODE_ENV"] === "development" && devVerOrUrl;
242
228
  var defaultVersion = "*";
243
229
  var isEntry = function(s) {
@@ -246,7 +232,7 @@ var parseEntry = function(str, devVerOrUrl) {
246
232
  // Check if the string starts with a type
247
233
  if (strSplit.length >= 2) {
248
234
  var _strSplit = _to_array(strSplit), name = _strSplit[0], versionOrEntryArr = _strSplit.slice(1);
249
- var versionOrEntry = devVersionOrUrl || versionOrEntryArr.join(separator);
235
+ var versionOrEntry = devVersionOrUrl || versionOrEntryArr.join(SEPARATOR);
250
236
  if (isEntry(versionOrEntry)) {
251
237
  return {
252
238
  name: name,
@@ -514,11 +500,10 @@ function generateSnapshotFromManifest(manifest) {
514
500
  };
515
501
  })
516
502
  };
517
- if ((_manifest_metaData = manifest.metaData) === null || _manifest_metaData === void 0 ? void 0 : _manifest_metaData.prefetchEntry) {
518
- var _manifest_metaData_prefetchEntry = manifest.metaData.prefetchEntry, path = _manifest_metaData_prefetchEntry.path, name = _manifest_metaData_prefetchEntry.name, type = _manifest_metaData_prefetchEntry.type;
503
+ if ((_manifest_metaData = manifest.metaData) === null || _manifest_metaData === void 0 ? void 0 : _manifest_metaData.prefetchInterface) {
504
+ var prefetchInterface = manifest.metaData.prefetchInterface;
519
505
  basicRemoteSnapshot = _object_spread_props(_object_spread({}, basicRemoteSnapshot), {
520
- prefetchEntry: simpleJoinRemoteEntry(path, name),
521
- prefetchEntryType: type
506
+ prefetchInterface: prefetchInterface
522
507
  });
523
508
  }
524
509
  if ("publicPath" in manifest.metaData) {
@@ -1164,15 +1149,11 @@ exports.EncodedNameTransformMap = EncodedNameTransformMap;
1164
1149
  exports.FederationModuleManifest = FederationModuleManifest;
1165
1150
  exports.Logger = Logger;
1166
1151
  exports.MANIFEST_EXT = MANIFEST_EXT;
1167
- exports.ManifestFileName = ManifestFileName;
1168
1152
  exports.NameTransformMap = NameTransformMap;
1169
1153
  exports.NameTransformSymbol = NameTransformSymbol;
1170
1154
  exports.SEPARATOR = SEPARATOR;
1171
- exports.StatsFileName = StatsFileName;
1172
1155
  exports.assert = assert;
1173
1156
  exports.composeKeyWithSeparator = composeKeyWithSeparator;
1174
- exports.containerPlugin = ContainerPlugin;
1175
- exports.containerReferencePlugin = ContainerReferencePlugin;
1176
1157
  exports.createLink = createLink;
1177
1158
  exports.createScript = createScript;
1178
1159
  exports.createScriptNode = createScriptNode;
@@ -1191,9 +1172,7 @@ exports.isStaticResourcesEqual = isStaticResourcesEqual;
1191
1172
  exports.loadScript = loadScript;
1192
1173
  exports.loadScriptNode = loadScriptNode;
1193
1174
  exports.logger = logger;
1194
- exports.moduleFederationPlugin = ModuleFederationPlugin;
1195
1175
  exports.parseEntry = parseEntry;
1196
1176
  exports.safeWrapper = safeWrapper;
1197
- exports.sharePlugin = SharePlugin;
1198
1177
  exports.simpleJoinRemoteEntry = simpleJoinRemoteEntry;
1199
1178
  exports.warn = warn;
package/dist/index.esm.js CHANGED
@@ -25,29 +25,6 @@ var NameTransformMap = (_obj = {}, _define_property$2(_obj, NameTransformSymbol.
25
25
  var _obj1;
26
26
  var EncodedNameTransformMap = (_obj1 = {}, _define_property$2(_obj1, NameTransformMap[NameTransformSymbol.AT], NameTransformSymbol.AT), _define_property$2(_obj1, NameTransformMap[NameTransformSymbol.HYPHEN], NameTransformSymbol.HYPHEN), _define_property$2(_obj1, NameTransformMap[NameTransformSymbol.SLASH], NameTransformSymbol.SLASH), _obj1);
27
27
  var SEPARATOR = ":";
28
- var ManifestFileName = "mf-manifest.json";
29
- var StatsFileName = "mf-stats.json";
30
- var ModuleType;
31
- (function(ModuleType) {
32
- ModuleType["NPM"] = "npm";
33
- ModuleType["APP"] = "app";
34
- })(ModuleType || (ModuleType = {}));
35
-
36
- var ContainerPlugin = /*#__PURE__*/Object.freeze({
37
- __proto__: null
38
- });
39
-
40
- var ContainerReferencePlugin = /*#__PURE__*/Object.freeze({
41
- __proto__: null
42
- });
43
-
44
- var ModuleFederationPlugin = /*#__PURE__*/Object.freeze({
45
- __proto__: null
46
- });
47
-
48
- var SharePlugin = /*#__PURE__*/Object.freeze({
49
- __proto__: null
50
- });
51
28
 
52
29
  function isBrowserEnv() {
53
30
  return typeof window !== "undefined";
@@ -127,13 +104,23 @@ function safeToString(info) {
127
104
  }
128
105
  }
129
106
  var DEBUG_LOG = "[ FEDERATION DEBUG ]";
107
+ function safeGetLocalStorageItem() {
108
+ try {
109
+ if (typeof window !== "undefined" && window.localStorage) {
110
+ return localStorage.getItem(BROWSER_LOG_KEY) === BROWSER_LOG_VALUE;
111
+ }
112
+ } catch (error) {
113
+ return typeof document !== "undefined";
114
+ }
115
+ return false;
116
+ }
130
117
  var Logger = /*#__PURE__*/ function() {
131
118
  function Logger(identifier) {
132
119
  _class_call_check(this, Logger);
133
120
  _define_property$1(this, "enable", false);
134
121
  _define_property$1(this, "identifier", void 0);
135
122
  this.identifier = identifier || DEBUG_LOG;
136
- if (isBrowserEnv() && localStorage.getItem(BROWSER_LOG_KEY) === BROWSER_LOG_VALUE) {
123
+ if (isBrowserEnv() && safeGetLocalStorageItem()) {
137
124
  this.enable = true;
138
125
  } else if (isDebugMode()) {
139
126
  this.enable = true;
@@ -232,8 +219,7 @@ var LOG_CATEGORY = "[ Federation Runtime ]";
232
219
  // entry: name:version version : 1.0.0 | ^1.2.3
233
220
  // entry: name:entry entry: https://localhost:9000/federation-manifest.json
234
221
  var parseEntry = function(str, devVerOrUrl) {
235
- var separator = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : SEPARATOR;
236
- var strSplit = str.split(separator);
222
+ var strSplit = str.split(SEPARATOR);
237
223
  var devVersionOrUrl = getProcessEnv()["NODE_ENV"] === "development" && devVerOrUrl;
238
224
  var defaultVersion = "*";
239
225
  var isEntry = function(s) {
@@ -242,7 +228,7 @@ var parseEntry = function(str, devVerOrUrl) {
242
228
  // Check if the string starts with a type
243
229
  if (strSplit.length >= 2) {
244
230
  var _strSplit = _to_array(strSplit), name = _strSplit[0], versionOrEntryArr = _strSplit.slice(1);
245
- var versionOrEntry = devVersionOrUrl || versionOrEntryArr.join(separator);
231
+ var versionOrEntry = devVersionOrUrl || versionOrEntryArr.join(SEPARATOR);
246
232
  if (isEntry(versionOrEntry)) {
247
233
  return {
248
234
  name: name,
@@ -510,11 +496,10 @@ function generateSnapshotFromManifest(manifest) {
510
496
  };
511
497
  })
512
498
  };
513
- if ((_manifest_metaData = manifest.metaData) === null || _manifest_metaData === void 0 ? void 0 : _manifest_metaData.prefetchEntry) {
514
- var _manifest_metaData_prefetchEntry = manifest.metaData.prefetchEntry, path = _manifest_metaData_prefetchEntry.path, name = _manifest_metaData_prefetchEntry.name, type = _manifest_metaData_prefetchEntry.type;
499
+ if ((_manifest_metaData = manifest.metaData) === null || _manifest_metaData === void 0 ? void 0 : _manifest_metaData.prefetchInterface) {
500
+ var prefetchInterface = manifest.metaData.prefetchInterface;
515
501
  basicRemoteSnapshot = _object_spread_props(_object_spread({}, basicRemoteSnapshot), {
516
- prefetchEntry: simpleJoinRemoteEntry(path, name),
517
- prefetchEntryType: type
502
+ prefetchInterface: prefetchInterface
518
503
  });
519
504
  }
520
505
  if ("publicPath" in manifest.metaData) {
@@ -1154,4 +1139,4 @@ function loadScriptNode(url, info) {
1154
1139
  });
1155
1140
  }
1156
1141
 
1157
- export { BROWSER_LOG_KEY, BROWSER_LOG_VALUE, EncodedNameTransformMap, FederationModuleManifest, Logger, MANIFEST_EXT, ManifestFileName, ModuleType, NameTransformMap, NameTransformSymbol, SEPARATOR, StatsFileName, assert, composeKeyWithSeparator, ContainerPlugin as containerPlugin, ContainerReferencePlugin as containerReferencePlugin, createLink, createScript, createScriptNode, decodeName, encodeName, error, generateExposeFilename, generateShareFilename, generateSnapshotFromManifest, getProcessEnv, getResourceUrl, isBrowserEnv, isDebugMode, isManifestProvider, isStaticResourcesEqual, loadScript, loadScriptNode, logger, ModuleFederationPlugin as moduleFederationPlugin, parseEntry, safeWrapper, SharePlugin as sharePlugin, simpleJoinRemoteEntry, warn };
1142
+ export { BROWSER_LOG_KEY, BROWSER_LOG_VALUE, EncodedNameTransformMap, FederationModuleManifest, Logger, MANIFEST_EXT, NameTransformMap, NameTransformSymbol, SEPARATOR, assert, composeKeyWithSeparator, createLink, createScript, createScriptNode, decodeName, encodeName, error, generateExposeFilename, generateShareFilename, generateSnapshotFromManifest, getProcessEnv, getResourceUrl, isBrowserEnv, isDebugMode, isManifestProvider, isStaticResourcesEqual, loadScript, loadScriptNode, logger, parseEntry, safeWrapper, simpleJoinRemoteEntry, warn };
@@ -14,9 +14,3 @@ export declare const EncodedNameTransformMap: {
14
14
  [x: string]: string;
15
15
  };
16
16
  export declare const SEPARATOR = ":";
17
- export declare const ManifestFileName = "mf-manifest.json";
18
- export declare const StatsFileName = "mf-stats.json";
19
- export declare enum ModuleType {
20
- NPM = "npm",
21
- APP = "app"
22
- }
@@ -2,4 +2,3 @@ export * from './common';
2
2
  export * from './manifest';
3
3
  export * from './stats';
4
4
  export * from './snapshot';
5
- export * from './plugins';
@@ -27,8 +27,7 @@ export interface BasicProviderModuleInfo extends BasicModuleInfo {
27
27
  modulePath?: string;
28
28
  assets: StatsAssets;
29
29
  }>;
30
- prefetchEntry?: string;
31
- prefetchEntryType?: RemoteEntryType;
30
+ prefetchInterface?: boolean;
32
31
  }
33
32
  interface BasicProviderModuleInfoWithPublicPath extends BasicProviderModuleInfo {
34
33
  publicPath: string;
@@ -1,4 +1,3 @@
1
- import { ModuleType } from '../constant';
2
1
  import type { RemoteWithEntry, RemoteWithVersion } from './common';
3
2
  export type RemoteEntryType = 'esm' | 'global';
4
3
  interface ResourceInfo {
@@ -15,10 +14,8 @@ export interface BasicStatsMetaData {
15
14
  globalName: string;
16
15
  buildInfo: StatsBuildInfo;
17
16
  remoteEntry: ResourceInfo;
18
- prefetchEntry?: ResourceInfo;
17
+ prefetchInterface: boolean;
19
18
  types: Omit<ResourceInfo, 'type'>;
20
- type: ModuleType;
21
- pluginVersion: string;
22
19
  }
23
20
  type StatsMetaDataWithGetPublicPath<T = BasicStatsMetaData> = T & {
24
21
  getPublicPath: string;
@@ -58,7 +55,7 @@ export type StatsRemoteWithVersion<T = StatsRemoteVal> = T & Omit<RemoteWithVers
58
55
  export type StatsRemote<T = StatsRemoteVal> = StatsRemoteWithEntry<T> | StatsRemoteWithVersion<T>;
59
56
  export interface StatsModuleInfo {
60
57
  name: string;
61
- file: string[];
58
+ file: string;
62
59
  }
63
60
  export interface ManifestModuleInfos {
64
61
  [exposeModuleName: string]: StatsModuleInfo;
@@ -1,6 +1,6 @@
1
1
  import { RemoteEntryInfo, ModuleInfo } from './types';
2
2
  import { Logger } from './logger';
3
- declare const parseEntry: (str: string, devVerOrUrl?: string, separator?: string) => RemoteEntryInfo;
3
+ declare const parseEntry: (str: string, devVerOrUrl?: string) => RemoteEntryInfo;
4
4
  declare global {
5
5
  var FEDERATION_DEBUG: string | undefined;
6
6
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@module-federation/sdk",
3
- "version": "0.0.0-next-20240227135200",
3
+ "version": "0.0.0-next-20240228024935",
4
4
  "license": "MIT",
5
5
  "description": "A sdk for support module federation",
6
6
  "keywords": [
@@ -1,159 +0,0 @@
1
- /**
2
- * 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.
3
- */
4
- export type Exposes = (ExposesItem | ExposesObject)[] | ExposesObject;
5
- /**
6
- * Module that should be exposed by this container.
7
- */
8
- export type ExposesItem = string;
9
- /**
10
- * Modules that should be exposed by this container.
11
- */
12
- export type ExposesItems = ExposesItem[];
13
- /**
14
- * Add a container for define/require functions in the AMD module.
15
- */
16
- export type AmdContainer = string;
17
- /**
18
- * Add a comment in the UMD wrapper.
19
- */
20
- export type AuxiliaryComment = string | LibraryCustomUmdCommentObject;
21
- /**
22
- * Specify which export should be exposed as library.
23
- */
24
- export type LibraryExport = string[] | string;
25
- /**
26
- * The name of the library (some types allow unnamed libraries too).
27
- */
28
- export type LibraryName = string[] | string | LibraryCustomUmdObject;
29
- /**
30
- * 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).
31
- */
32
- 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;
33
- /**
34
- * If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module.
35
- */
36
- export type UmdNamedDefine = boolean;
37
- /**
38
- * The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
39
- */
40
- export type EntryRuntime = false | string;
41
- export interface ContainerPluginOptions {
42
- /**
43
- * 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.
44
- */
45
- exposes: Exposes;
46
- /**
47
- * The filename for this container relative path inside the `output.path` directory.
48
- */
49
- filename?: string;
50
- /**
51
- * Options for library.
52
- */
53
- library?: LibraryOptions;
54
- /**
55
- * The name for this container.
56
- */
57
- name: string;
58
- /**
59
- * The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
60
- */
61
- runtime?: EntryRuntime;
62
- /**
63
- * The name of the share scope which is shared with the host (defaults to 'default').
64
- */
65
- shareScope?: string;
66
- /**
67
- * Runtime plugin file paths or package name.
68
- */
69
- runtimePlugins?: string[];
70
- }
71
- /**
72
- * Modules that should be exposed by this container. Property names are used as public paths.
73
- */
74
- export interface ExposesObject {
75
- /**
76
- * Modules that should be exposed by this container.
77
- */
78
- [k: string]: ExposesConfig | ExposesItem | ExposesItems;
79
- }
80
- /**
81
- * Advanced configuration for modules that should be exposed by this container.
82
- */
83
- export interface ExposesConfig {
84
- /**
85
- * Request to a module that should be exposed by this container.
86
- */
87
- import: ExposesItem | ExposesItems;
88
- /**
89
- * Custom chunk name for the exposed module.
90
- */
91
- name?: string;
92
- }
93
- /**
94
- * Options for library.
95
- */
96
- export interface LibraryOptions {
97
- /**
98
- * Add a container for define/require functions in the AMD module.
99
- */
100
- amdContainer?: AmdContainer;
101
- /**
102
- * Add a comment in the UMD wrapper.
103
- */
104
- auxiliaryComment?: AuxiliaryComment;
105
- /**
106
- * Specify which export should be exposed as library.
107
- */
108
- export?: LibraryExport;
109
- /**
110
- * The name of the library (some types allow unnamed libraries too).
111
- */
112
- name?: LibraryName;
113
- /**
114
- * 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).
115
- */
116
- type: LibraryType;
117
- /**
118
- * If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module.
119
- */
120
- umdNamedDefine?: UmdNamedDefine;
121
- }
122
- /**
123
- * Set explicit comments for `commonjs`, `commonjs2`, `amd`, and `root`.
124
- */
125
- export interface LibraryCustomUmdCommentObject {
126
- /**
127
- * Set comment for `amd` section in UMD.
128
- */
129
- amd?: string;
130
- /**
131
- * Set comment for `commonjs` (exports) section in UMD.
132
- */
133
- commonjs?: string;
134
- /**
135
- * Set comment for `commonjs2` (module.exports) section in UMD.
136
- */
137
- commonjs2?: string;
138
- /**
139
- * Set comment for `root` (global variable) section in UMD.
140
- */
141
- root?: string;
142
- }
143
- /**
144
- * Description object for all UMD variants of the library name.
145
- */
146
- export interface LibraryCustomUmdObject {
147
- /**
148
- * Name of the exposed AMD library in the UMD.
149
- */
150
- amd?: string;
151
- /**
152
- * Name of the exposed commonjs export in the UMD.
153
- */
154
- commonjs?: string;
155
- /**
156
- * Name of the property exposed globally by a UMD library.
157
- */
158
- root?: string[] | string;
159
- }
@@ -1,52 +0,0 @@
1
- /**
2
- * Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value).
3
- */
4
- 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';
5
- /**
6
- * 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.
7
- */
8
- export type Remotes = (RemotesItem | RemotesObject)[] | RemotesObject;
9
- /**
10
- * Container location from which modules should be resolved and loaded at runtime.
11
- */
12
- export type RemotesItem = string;
13
- /**
14
- * Container locations from which modules should be resolved and loaded at runtime.
15
- */
16
- export type RemotesItems = RemotesItem[];
17
- export interface ContainerReferencePluginOptions {
18
- /**
19
- * The external type of the remote containers.
20
- */
21
- remoteType: ExternalsType;
22
- /**
23
- * 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.
24
- */
25
- remotes: Remotes;
26
- /**
27
- * The name of the share scope shared with all remotes (defaults to 'default').
28
- */
29
- shareScope?: string;
30
- }
31
- /**
32
- * Container locations from which modules should be resolved and loaded at runtime. Property names are used as request scopes.
33
- */
34
- export interface RemotesObject {
35
- /**
36
- * Container locations from which modules should be resolved and loaded at runtime.
37
- */
38
- [k: string]: RemotesConfig | RemotesItem | RemotesItems;
39
- }
40
- /**
41
- * Advanced configuration for container locations from which modules should be resolved and loaded at runtime.
42
- */
43
- export interface RemotesConfig {
44
- /**
45
- * Container locations from which modules should be resolved and loaded at runtime.
46
- */
47
- external: RemotesItem | RemotesItems;
48
- /**
49
- * The name of the share scope shared with this remote.
50
- */
51
- shareScope?: string;
52
- }
@@ -1,276 +0,0 @@
1
- /**
2
- * 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.
3
- */
4
- export type Exposes = (ExposesItem | ExposesObject)[] | ExposesObject;
5
- /**
6
- * Module that should be exposed by this container.
7
- */
8
- export type ExposesItem = string;
9
- /**
10
- * Modules that should be exposed by this container.
11
- */
12
- export type ExposesItems = ExposesItem[];
13
- /**
14
- * Add a container for define/require functions in the AMD module.
15
- */
16
- export type AmdContainer = string;
17
- /**
18
- * Add a comment in the UMD wrapper.
19
- */
20
- export type AuxiliaryComment = string | LibraryCustomUmdCommentObject;
21
- /**
22
- * Specify which export should be exposed as library.
23
- */
24
- export type LibraryExport = string[] | string;
25
- /**
26
- * The name of the library (some types allow unnamed libraries too).
27
- */
28
- export type LibraryName = string[] | string | LibraryCustomUmdObject;
29
- /**
30
- * 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).
31
- */
32
- 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;
33
- /**
34
- * If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module.
35
- */
36
- export type UmdNamedDefine = boolean;
37
- /**
38
- * Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value).
39
- */
40
- 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';
41
- /**
42
- * 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.
43
- */
44
- export type Remotes = (RemotesItem | RemotesObject)[] | RemotesObject;
45
- /**
46
- * Container location from which modules should be resolved and loaded at runtime.
47
- */
48
- export type RemotesItem = string;
49
- /**
50
- * Container locations from which modules should be resolved and loaded at runtime.
51
- */
52
- export type RemotesItems = RemotesItem[];
53
- /**
54
- * The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
55
- */
56
- export type EntryRuntime = false | string;
57
- /**
58
- * Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
59
- */
60
- export type Shared = (SharedItem | SharedObject)[] | SharedObject;
61
- /**
62
- * A module that should be shared in the share scope.
63
- */
64
- export type SharedItem = string;
65
- export interface PluginManifestOptions {
66
- filePath?: string;
67
- disableAssetsAnalyze?: boolean;
68
- }
69
- export interface ModuleFederationPluginOptions {
70
- /**
71
- * 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.
72
- */
73
- exposes?: Exposes;
74
- /**
75
- * The filename of the container as relative path inside the `output.path` directory.
76
- */
77
- filename?: string;
78
- /**
79
- * Options for library.
80
- */
81
- library?: LibraryOptions;
82
- /**
83
- * The name of the container.
84
- */
85
- name?: string;
86
- /**
87
- * The external type of the remote containers.
88
- */
89
- remoteType?: ExternalsType;
90
- /**
91
- * 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.
92
- */
93
- remotes?: Remotes;
94
- /**
95
- * The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
96
- */
97
- runtime?: EntryRuntime;
98
- /**
99
- * Share scope name used for all shared modules (defaults to 'default').
100
- */
101
- shareScope?: string;
102
- /**
103
- * Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
104
- */
105
- shared?: Shared;
106
- /**
107
- * Runtime plugin file paths or package name.
108
- */
109
- runtimePlugins?: string[];
110
- /**
111
- * Bundler runtime path
112
- */
113
- implementation?: string;
114
- manifest?: boolean | PluginManifestOptions;
115
- }
116
- /**
117
- * Modules that should be exposed by this container. Property names are used as public paths.
118
- */
119
- export interface ExposesObject {
120
- /**
121
- * Modules that should be exposed by this container.
122
- */
123
- [k: string]: ExposesConfig | ExposesItem | ExposesItems;
124
- }
125
- /**
126
- * Advanced configuration for modules that should be exposed by this container.
127
- */
128
- export interface ExposesConfig {
129
- /**
130
- * Request to a module that should be exposed by this container.
131
- */
132
- import: ExposesItem | ExposesItems;
133
- /**
134
- * Custom chunk name for the exposed module.
135
- */
136
- name?: string;
137
- }
138
- /**
139
- * Options for library.
140
- */
141
- export interface LibraryOptions {
142
- /**
143
- * Add a container for define/require functions in the AMD module.
144
- */
145
- amdContainer?: AmdContainer;
146
- /**
147
- * Add a comment in the UMD wrapper.
148
- */
149
- auxiliaryComment?: AuxiliaryComment;
150
- /**
151
- * Specify which export should be exposed as library.
152
- */
153
- export?: LibraryExport;
154
- /**
155
- * The name of the library (some types allow unnamed libraries too).
156
- */
157
- name?: LibraryName;
158
- /**
159
- * 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).
160
- */
161
- type: LibraryType;
162
- /**
163
- * If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module.
164
- */
165
- umdNamedDefine?: UmdNamedDefine;
166
- }
167
- /**
168
- * Set explicit comments for `commonjs`, `commonjs2`, `amd`, and `root`.
169
- */
170
- export interface LibraryCustomUmdCommentObject {
171
- /**
172
- * Set comment for `amd` section in UMD.
173
- */
174
- amd?: string;
175
- /**
176
- * Set comment for `commonjs` (exports) section in UMD.
177
- */
178
- commonjs?: string;
179
- /**
180
- * Set comment for `commonjs2` (module.exports) section in UMD.
181
- */
182
- commonjs2?: string;
183
- /**
184
- * Set comment for `root` (global variable) section in UMD.
185
- */
186
- root?: string;
187
- }
188
- /**
189
- * Description object for all UMD variants of the library name.
190
- */
191
- export interface LibraryCustomUmdObject {
192
- /**
193
- * Name of the exposed AMD library in the UMD.
194
- */
195
- amd?: string;
196
- /**
197
- * Name of the exposed commonjs export in the UMD.
198
- */
199
- commonjs?: string;
200
- /**
201
- * Name of the property exposed globally by a UMD library.
202
- */
203
- root?: string[] | string;
204
- }
205
- /**
206
- * Container locations from which modules should be resolved and loaded at runtime. Property names are used as request scopes.
207
- */
208
- export interface RemotesObject {
209
- /**
210
- * Container locations from which modules should be resolved and loaded at runtime.
211
- */
212
- [k: string]: RemotesConfig | RemotesItem | RemotesItems;
213
- }
214
- /**
215
- * Advanced configuration for container locations from which modules should be resolved and loaded at runtime.
216
- */
217
- export interface RemotesConfig {
218
- /**
219
- * Container locations from which modules should be resolved and loaded at runtime.
220
- */
221
- external: RemotesItem | RemotesItems;
222
- /**
223
- * The name of the share scope shared with this remote.
224
- */
225
- shareScope?: string;
226
- }
227
- /**
228
- * 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.
229
- */
230
- export interface SharedObject {
231
- /**
232
- * Modules that should be shared in the share scope.
233
- */
234
- [k: string]: SharedConfig | SharedItem;
235
- }
236
- /**
237
- * Advanced configuration for modules that should be shared in the share scope.
238
- */
239
- export interface SharedConfig {
240
- /**
241
- * 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.
242
- */
243
- eager?: boolean;
244
- /**
245
- * 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.
246
- */
247
- import?: false | SharedItem;
248
- /**
249
- * Package name to determine required version from description file. This is only needed when package name can't be automatically determined from request.
250
- */
251
- packageName?: string;
252
- /**
253
- * Version requirement from module in share scope.
254
- */
255
- requiredVersion?: false | string;
256
- /**
257
- * Module is looked up under this key from the share scope.
258
- */
259
- shareKey?: string;
260
- /**
261
- * Share scope name.
262
- */
263
- shareScope?: string;
264
- /**
265
- * Allow only a single version of the shared module in share scope (disabled by default).
266
- */
267
- singleton?: boolean;
268
- /**
269
- * 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).
270
- */
271
- strictVersion?: boolean;
272
- /**
273
- * Version of the provided module. Will replace lower matching versions, but not higher.
274
- */
275
- version?: false | string;
276
- }
@@ -1,71 +0,0 @@
1
- /**
2
- * Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
3
- */
4
- export type Shared = (SharedItem | SharedObject)[] | SharedObject;
5
- /**
6
- * A module that should be shared in the share scope.
7
- */
8
- export type SharedItem = string;
9
- /**
10
- * Options for shared modules.
11
- */
12
- export interface SharePluginOptions {
13
- /**
14
- * Share scope name used for all shared modules (defaults to 'default').
15
- */
16
- shareScope?: string;
17
- /**
18
- * Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
19
- */
20
- shared: Shared;
21
- }
22
- /**
23
- * 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.
24
- */
25
- export interface SharedObject {
26
- /**
27
- * Modules that should be shared in the share scope.
28
- */
29
- [k: string]: SharedConfig | SharedItem;
30
- }
31
- /**
32
- * Advanced configuration for modules that should be shared in the share scope.
33
- */
34
- export interface SharedConfig {
35
- /**
36
- * 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.
37
- */
38
- eager?: boolean;
39
- /**
40
- * 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.
41
- */
42
- import?: false | SharedItem;
43
- /**
44
- * Package name to determine required version from description file. This is only needed when package name can't be automatically determined from request.
45
- */
46
- packageName?: string;
47
- /**
48
- * Version requirement from module in share scope.
49
- */
50
- requiredVersion?: false | string;
51
- /**
52
- * Module is looked up under this key from the share scope.
53
- */
54
- shareKey?: string;
55
- /**
56
- * Share scope name.
57
- */
58
- shareScope?: string;
59
- /**
60
- * Allow only a single version of the shared module in share scope (disabled by default).
61
- */
62
- singleton?: boolean;
63
- /**
64
- * 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).
65
- */
66
- strictVersion?: boolean;
67
- /**
68
- * Version of the provided module. Will replace lower matching versions, but not higher.
69
- */
70
- version?: false | string;
71
- }
@@ -1,4 +0,0 @@
1
- export * as containerPlugin from './ContainerPlugin';
2
- export * as containerReferencePlugin from './ContainerReferencePlugin';
3
- export * as moduleFederationPlugin from './ModuleFederationPlugin';
4
- export * as sharePlugin from './SharePlugin';