@pushwoosh/frontend-builder-engine 5.3.1 → 5.4.0

package/README.md

@@ -95,10 +95,19 @@ module.exports = {
 };
 ```
 
+A list externalises only the named kit packages, the rest stays bundled; `true` is the full list above.
+A name outside that list fails the build.
+
+```js
+module.exports = {
+  sharedKit: ['@pushwoosh/kit-icons'],
+};
+```
+
 Only the package roots are external, because only roots are in the import map. A deep import such as
 `@pushwoosh/dumb-components/polyglot` would be bundled into the app as a second copy of the module
-(its own React contexts), so with `sharedKit` it fails the build instead; import the kit through its
-roots. Turn the option on after every one of these names is in the import map.
+(its own React contexts), so with `sharedKit` it fails the build instead, for the externalised packages
+only; import them through their roots. Turn the option on after every listed name is in the import map.
 
 ## Migration from v3
 

package/lib/webpack.application.config.js

@@ -43,11 +43,32 @@ const sharedKitExternals = [
   '@pushwoosh/kit-icons',
 ];
 
+const resolveSharedKit = (option) => {
+  if (!option) {
+    return [];
+  }
+  if (option === true) {
+    return sharedKitExternals;
+  }
+  if (!Array.isArray(option)) {
+    throw new Error('pushwoosh.config.js: sharedKit must be true or a list of kit package names');
+  }
+  const unknown = option.filter((name) => !sharedKitExternals.includes(name));
+  if (unknown.length > 0) {
+    throw new Error(`pushwoosh.config.js: sharedKit lists ${unknown.join(', ')}, not a kit package; allowed: ${sharedKitExternals.join(', ')}`);
+  }
+  return option;
+};
+
 class SharedKitDeepImportGuard {
+  constructor(packages) {
+    this.packages = packages;
+  }
+
   apply(compiler) {
     compiler.hooks.normalModuleFactory.tap('SharedKitDeepImportGuard', (factory) => {
       factory.hooks.beforeResolve.tap('SharedKitDeepImportGuard', ({ request }) => {
-        const root = sharedKitExternals.find((name) => request.startsWith(`${name}/`));
+        const root = this.packages.find((name) => request.startsWith(`${name}/`));
         if (root) {
           throw new Error(`${request}: with sharedKit the kit loads from the import map by its package root only, import from '${root}'`);
         }
@@ -69,7 +90,8 @@ module.exports = (webpackConfigEnv, argv) => {
   const isProduction = NODE_ENV === 'production';
   const variables = loadVariables(!isProduction);
 
-  const externals = pushwooshConfig.sharedKit ? [...defaultExternals, ...sharedKitExternals] : defaultExternals;
+  const sharedKit = resolveSharedKit(pushwooshConfig.sharedKit);
+  const externals = [...defaultExternals, ...sharedKit];
 
   const defaultConfig = singleSpaDefaults({
     orgName,
@@ -99,7 +121,7 @@ module.exports = (webpackConfigEnv, argv) => {
     },
     externals: pushwooshConfig.applicationExternals ? pushwooshConfig.applicationExternals(externals) : externals,
     plugins: [
-      ...(pushwooshConfig.sharedKit ? [new SharedKitDeepImportGuard()] : []),
+      ...(sharedKit.length > 0 ? [new SharedKitDeepImportGuard(sharedKit)] : []),
       new webpack.DefinePlugin({
         process: {
           env: JSON.stringify({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/frontend-builder-engine",
-  "version": "5.3.1",
+  "version": "5.4.0",
   "description": "Pushwoosh frontend builder engine",
   "repository": {
     "type": "git",