@lwrjs/tools 0.11.0-alpha.8 → 0.11.0

package/build/cjs/dedupe-bundles.cjs

@@ -0,0 +1,133 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {get: all[name], enumerable: true});
+};
+var __exportStar = (target, module2, desc) => {
+  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
+    for (let key of __getOwnPropNames(module2))
+      if (!__hasOwnProp.call(target, key) && key !== "default")
+        __defProp(target, key, {get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable});
+  }
+  return target;
+};
+var __toModule = (module2) => {
+  return __exportStar(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? {get: () => module2.default, enumerable: true} : {value: module2, enumerable: true})), module2);
+};
+
+// packages/@lwrjs/tools/src/dedupe-bundles.ts
+__markAsModule(exports);
+__export(exports, {
+  dedupeBundles: () => dedupeBundles
+});
+var import_fs_extra = __toModule(require("fs-extra"));
+var import_path = __toModule(require("path"));
+var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
+var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
+var DEFAULT_KEY = "default";
+async function dedupeBundles(siteRoot, i18n) {
+  const bundleMetadataFilePath = import_path.default.join(siteRoot, "/.metadata/bundle-metadata.json");
+  const siteBundles = await import_fs_extra.default.readJSON(bundleMetadataFilePath);
+  import_diagnostics.logger.info(`[dedupeBundles] Deduplicating ${Object.keys(siteBundles.bundles).length} bundles`);
+  const groupedBundles = groupBundlesByLocales(siteBundles);
+  import_diagnostics.logger.debug(`[dedupeBundles] Found ${Object.keys(groupedBundles).length} grouped bundles`);
+  const updatedBundleMetadata = {bundles: {}};
+  const updatedBundles = updatedBundleMetadata.bundles;
+  for (const specifier of Object.keys(groupedBundles)) {
+    const variants = groupedBundles[specifier];
+    const defaultVariant = variants[DEFAULT_KEY];
+    if (defaultVariant) {
+      updatedBundles[specifier] = defaultVariant;
+      const defaultSource = String(import_fs_extra.default.readFileSync(import_path.default.join(siteRoot, defaultVariant.path)));
+      for (const variantKey of Object.keys(variants)) {
+        if (variantKey !== DEFAULT_KEY) {
+          let dedupeSource = false;
+          const variant = variants[variantKey];
+          const variantSource = String(import_fs_extra.default.readFileSync(import_path.default.join(siteRoot, variant.path)));
+          const localeId = extractLocale(variantKey);
+          if (localeId) {
+            dedupeSource = await (0, import_shared_utils.walkLocaleFallbacks)(localeId, i18n, async (curLocale) => {
+              if (curLocale === localeId) {
+                return false;
+              }
+              if (curLocale === i18n.defaultLocale) {
+                return variantSource === defaultSource;
+              }
+              const curVariant = variants[`l/${curLocale}`];
+              if (curVariant) {
+                const curPath = import_path.default.join(siteRoot, curVariant.path);
+                if (await import_fs_extra.default.pathExists(curPath)) {
+                  const curVariantSource = String(import_fs_extra.default.readFileSync(curPath));
+                  return variantSource === curVariantSource;
+                }
+              }
+              return false;
+            });
+          }
+          if (dedupeSource) {
+            import_diagnostics.logger.debug(`[dedupeBundles] Remove duplicate variant ${specifier}|${variantKey}`);
+            import_fs_extra.default.removeSync(import_path.default.join(siteRoot, variant.path));
+          } else {
+            const variant2 = variants[variantKey];
+            updatedBundles[`${specifier}|${variantKey}`] = variant2;
+          }
+        }
+      }
+    }
+  }
+  import_diagnostics.logger.info(`[dedupeBundles] Deduplicated down to ${Object.keys(updatedBundleMetadata.bundles).length} bundles`);
+  await import_fs_extra.default.writeJSON(bundleMetadataFilePath, updatedBundleMetadata, {spaces: 2});
+  deleteEmptyFolders(siteRoot);
+}
+var LOCALE_PATTERN = /(?:^|\/)l\/([\w-_]+)/;
+function extractLocale(variantKey) {
+  const match = variantKey.match(LOCALE_PATTERN);
+  if (match) {
+    return match[1];
+  }
+  return void 0;
+}
+function groupBundlesByLocales(siteBundles) {
+  const groupedBundles = {};
+  for (const specifier of Object.keys(siteBundles.bundles)) {
+    const parts = specifier.split("|");
+    const firstPart = parts[0];
+    const secondPart = parts.length > 1 ? parts[1] : DEFAULT_KEY;
+    import_diagnostics.logger.debug(`[dedupeBundles] ${specifier} -> groupedBundles[${firstPart}][${secondPart}]`);
+    if (!groupedBundles[firstPart]) {
+      groupedBundles[firstPart] = {};
+    }
+    groupedBundles[firstPart][secondPart] = siteBundles.bundles[specifier];
+  }
+  return groupedBundles;
+}
+function deleteEmptyFolders(directory) {
+  if (!import_fs_extra.default.existsSync(directory)) {
+    import_diagnostics.logger.warn(`[dedupeBundles] Directory does not exist: ${directory}`);
+    return;
+  }
+  const files = import_fs_extra.default.readdirSync(directory);
+  if (files.length === 0) {
+    import_fs_extra.default.rmdirSync(directory);
+    import_diagnostics.logger.debug(`[dedupeBundles] Deleted empty folder: ${directory}`);
+    return;
+  }
+  files.forEach((file) => {
+    const filePath = import_path.default.join(directory, file);
+    const isDirectory = import_fs_extra.default.statSync(filePath).isDirectory();
+    if (isDirectory) {
+      deleteEmptyFolders(filePath);
+    }
+  });
+  const updatedFiles = import_fs_extra.default.readdirSync(directory);
+  if (updatedFiles.length === 0) {
+    import_fs_extra.default.rmdirSync(directory);
+    import_diagnostics.logger.debug(`[dedupeBundles] Deleted empty folder: ${directory}`);
+  }
+}

package/build/cjs/index.cjs

@@ -24,6 +24,8 @@ var __toModule = (module2) => {
 // packages/@lwrjs/tools/src/index.ts
 __markAsModule(exports);
 __export(exports, {
-  buildServer: () => import_server_build.buildServer
+  buildServer: () => import_server_build.buildServer,
+  dedupeBundles: () => import_dedupe_bundles.dedupeBundles
 });
 var import_server_build = __toModule(require("./server-build.cjs"));
+var import_dedupe_bundles = __toModule(require("./dedupe-bundles.cjs"));

package/build/cjs/plugins/build-server-plugin.cjs

@@ -29,6 +29,7 @@ __export(exports, {
 var import_path = __toModule(require("path"));
 var import_config = __toModule(require("@lwrjs/config"));
 var import_modules = __toModule(require("@lwrjs/config/modules"));
+var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
 function getServices(t) {
   return t;
@@ -65,7 +66,7 @@ function processHooks(hooksConfig, hooks, rootDir) {
       continue;
     }
     if (hooks[index].initConfigs) {
-      import_shared_utils.logger.warn("Consider splitting `initConfigs` hooks to a separate file.");
+      import_diagnostics.logger.warn("Consider splitting `initConfigs` hooks to a separate file.");
     }
     const name = "hook" + index;
     output.imports.push(`import ${name} from '${(0, import_shared_utils.normalizeDirectory)(entry, rootDir)}';`);

package/build/cjs/plugins/generate-entry-plugin.cjs

@@ -42,6 +42,7 @@ function generateLwrEntry() {
       build.onLoad({filter: /.*/, namespace: "lwr-entry"}, (args) => ({
         contents: [
           `/* This module is generated */`,
+          `import 'source-map-support/register'`,
           `import { createHandler } from '@lwrjs/lambda';`,
           `import * as build from './lwr.build.js';`,
           `const handler = createHandler(build);`,

package/build/cjs/server-build.cjs

@@ -30,6 +30,7 @@ var import_path = __toModule(require("path"));
 var import_fs_extra = __toModule(require("fs-extra"));
 var import_esbuild = __toModule(require("esbuild"));
 var import_perf_hooks = __toModule(require("perf_hooks"));
+var import_diagnostics = __toModule(require("@lwrjs/diagnostics"));
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
 var import_config = __toModule(require("@lwrjs/config"));
 var import_generate_entry_plugin = __toModule(require("./plugins/generate-entry-plugin.cjs"));
@@ -41,6 +42,7 @@ async function build(buildOptions, config) {
     bundle: true,
     minify,
     sourcemap: true,
+    sourcesContent: false,
     format: "cjs",
     platform: "node",
     logLevel: "silent",
@@ -67,7 +69,7 @@ async function buildServer(configArg, options) {
   await build({outputDir, normalizedOutputDir, minify: !!options?.minify}, configArg);
   const endTime = import_perf_hooks.performance.now();
   const timeDiff = endTime - startTime;
-  import_shared_utils.logger.info(`[Server Build] successfully built the server in ${Math.round(timeDiff)} ms`);
+  import_diagnostics.logger.info(`[Server Build] successfully built the server in ${Math.round(timeDiff)} ms`);
 }
 function createEnvVarHeader() {
   const currentFeatureFlags = (0, import_shared_utils.getFeatureFlags)();

package/build/es/dedupe-bundles.d.ts

@@ -0,0 +1,8 @@
+import type { I18NConfig } from '@lwrjs/types';
+/**
+ * De-duplicate generated bundles
+ *
+ * @param siteRoot The root folder for generated bundles
+ */
+export declare function dedupeBundles(siteRoot: string, i18n: I18NConfig): Promise<void>;
+//# sourceMappingURL=dedupe-bundles.d.ts.map

package/build/es/dedupe-bundles.js

@@ -0,0 +1,130 @@
+import fs from 'fs-extra';
+import path from 'path';
+import { logger } from '@lwrjs/diagnostics';
+import { walkLocaleFallbacks } from '@lwrjs/shared-utils';
+const DEFAULT_KEY = 'default';
+/**
+ * De-duplicate generated bundles
+ *
+ * @param siteRoot The root folder for generated bundles
+ */
+export async function dedupeBundles(siteRoot, i18n) {
+    // Read the bundle site metadata
+    const bundleMetadataFilePath = path.join(siteRoot, '/.metadata/bundle-metadata.json');
+    const siteBundles = await fs.readJSON(bundleMetadataFilePath);
+    logger.info(`[dedupeBundles] Deduplicating ${Object.keys(siteBundles.bundles).length} bundles`);
+    // Group the bundles by locale
+    const groupedBundles = groupBundlesByLocales(siteBundles);
+    logger.debug(`[dedupeBundles] Found ${Object.keys(groupedBundles).length} grouped bundles`);
+    const updatedBundleMetadata = { bundles: {} };
+    const updatedBundles = updatedBundleMetadata.bundles;
+    for (const specifier of Object.keys(groupedBundles)) {
+        const variants = groupedBundles[specifier];
+        const defaultVariant = variants[DEFAULT_KEY];
+        if (defaultVariant) {
+            updatedBundles[specifier] = defaultVariant;
+            const defaultSource = String(fs.readFileSync(path.join(siteRoot, defaultVariant.path)));
+            // Wite out each variant
+            for (const variantKey of Object.keys(variants)) {
+                if (variantKey !== DEFAULT_KEY) {
+                    // Find the first source that does not match its parent
+                    let dedupeSource = false;
+                    // Read the current variant source
+                    const variant = variants[variantKey];
+                    const variantSource = String(fs.readFileSync(path.join(siteRoot, variant.path)));
+                    const localeId = extractLocale(variantKey);
+                    // If this locale is n
+                    if (localeId) {
+                        // eslint-disable-next-line no-await-in-loop
+                        dedupeSource = await walkLocaleFallbacks(localeId, i18n, async (curLocale) => {
+                            // If this is the current locale skip
+                            if (curLocale === localeId) {
+                                return false;
+                            }
+                            // If this is a default local test against the read default
+                            if (curLocale === i18n.defaultLocale) {
+                                return variantSource === defaultSource;
+                            }
+                            // See if there is a variant for the current locale
+                            const curVariant = variants[`l/${curLocale}`];
+                            if (curVariant) {
+                                const curPath = path.join(siteRoot, curVariant.path);
+                                if (await fs.pathExists(curPath)) {
+                                    const curVariantSource = String(fs.readFileSync(curPath));
+                                    return variantSource === curVariantSource;
+                                }
+                            }
+                            return false;
+                        });
+                    }
+                    if (dedupeSource) {
+                        logger.debug(`[dedupeBundles] Remove duplicate variant ${specifier}|${variantKey}`);
+                        fs.removeSync(path.join(siteRoot, variant.path));
+                    }
+                    else {
+                        // keep the variant in the metadata
+                        const variant = variants[variantKey];
+                        updatedBundles[`${specifier}|${variantKey}`] = variant;
+                    }
+                }
+            }
+        }
+    }
+    logger.info(`[dedupeBundles] Deduplicated down to ${Object.keys(updatedBundleMetadata.bundles).length} bundles`);
+    // Save the updated bundle metadata
+    await fs.writeJSON(bundleMetadataFilePath, updatedBundleMetadata, { spaces: 2 });
+    // Clean up empty folders
+    deleteEmptyFolders(siteRoot);
+}
+const LOCALE_PATTERN = /(?:^|\/)l\/([\w-_]+)/;
+/**
+ * Extract the locale definition from a variant key 'l/{localeId}'
+ */
+function extractLocale(variantKey) {
+    const match = variantKey.match(LOCALE_PATTERN);
+    if (match) {
+        return match[1]; // The 'key' is captured in the first capture group
+    }
+    return undefined;
+}
+function groupBundlesByLocales(siteBundles) {
+    const groupedBundles = {};
+    for (const specifier of Object.keys(siteBundles.bundles)) {
+        const parts = specifier.split('|');
+        // Extract the desired parts
+        const firstPart = parts[0];
+        const secondPart = parts.length > 1 ? parts[1] : DEFAULT_KEY;
+        logger.debug(`[dedupeBundles] ${specifier} -> groupedBundles[${firstPart}][${secondPart}]`);
+        if (!groupedBundles[firstPart]) {
+            groupedBundles[firstPart] = {};
+        }
+        groupedBundles[firstPart][secondPart] = siteBundles.bundles[specifier];
+    }
+    return groupedBundles;
+}
+function deleteEmptyFolders(directory) {
+    if (!fs.existsSync(directory)) {
+        logger.warn(`[dedupeBundles] Directory does not exist: ${directory}`);
+        return;
+    }
+    const files = fs.readdirSync(directory);
+    if (files.length === 0) {
+        fs.rmdirSync(directory);
+        logger.debug(`[dedupeBundles] Deleted empty folder: ${directory}`);
+        return;
+    }
+    files.forEach((file) => {
+        const filePath = path.join(directory, file);
+        const isDirectory = fs.statSync(filePath).isDirectory();
+        if (isDirectory) {
+            deleteEmptyFolders(filePath);
+        }
+    });
+    // Check if the directory is empty after deleting its subdirectories
+    const updatedFiles = fs.readdirSync(directory);
+    if (updatedFiles.length === 0) {
+        fs.rmdirSync(directory);
+        logger.debug(`[dedupeBundles] Deleted empty folder: ${directory}`);
+    }
+}
+//# sourceMappingURL=dedupe-bundles.js.map

package/build/es/index.d.ts

@@ -1,2 +1,3 @@
 export { buildServer } from './server-build.js';
+export { dedupeBundles } from './dedupe-bundles.js';
 //# sourceMappingURL=index.d.ts.map

package/build/es/index.js

@@ -1,2 +1,3 @@
 export { buildServer } from './server-build.js';
+export { dedupeBundles } from './dedupe-bundles.js';
 //# sourceMappingURL=index.js.map

package/build/es/plugins/build-server-plugin.js

@@ -1,7 +1,8 @@
 import path from 'path';
 import { executeConfigHooks, loadConfig } from '@lwrjs/config';
 import { loadHooks } from '@lwrjs/config/modules';
-import { logger, normalizeDirectory } from '@lwrjs/shared-utils';
+import { logger } from '@lwrjs/diagnostics';
+import { normalizeDirectory } from '@lwrjs/shared-utils';
 function getServices(t) {
     return t;
 }

package/build/es/plugins/generate-entry-plugin.js

@@ -24,6 +24,11 @@ export default function generateLwrEntry() {
             build.onLoad({ filter: /.*/, namespace: 'lwr-entry' }, (args) => ({
                 contents: [
                     `/* This module is generated */`,
+                    // This package is not technically necessary as node 12 includes this functionality, but in the
+                    // LWR@MRT environment, we have no control over environment variables so we have no way to configure
+                    // NODE_OPTIONS='--enable-source-maps'. So this is a necessary workaround for now with minimal downside.
+                    // See: https://nodejs.org/docs/latest-v18.x/api/cli.html#--enable-source-maps
+                    `import 'source-map-support/register'`,
                     `import { createHandler } from '@lwrjs/lambda';`,
                     // Importing the server build module at this point enables support for ESM bundling.
                     // If the server build module was imported in `createHandler`, it would need to be exposed

package/build/es/server-build.js

@@ -2,7 +2,8 @@ import path from 'path';
 import fs from 'fs-extra';
 import esbuild from 'esbuild';
 import { performance } from 'perf_hooks';
-import { getFeatureFlags, logger } from '@lwrjs/shared-utils';
+import { logger } from '@lwrjs/diagnostics';
+import { getFeatureFlags } from '@lwrjs/shared-utils';
 import { LWR_VERSION, LWC_VERSION } from '@lwrjs/config';
 import generateLwrEntry from './plugins/generate-entry-plugin.js';
 import buildLwrServer from './plugins/build-server-plugin.js';
@@ -14,6 +15,7 @@ async function build(buildOptions, config) {
         bundle: true,
         minify,
         sourcemap: true,
+        sourcesContent: false,
         format: 'cjs',
         platform: 'node',
         logLevel: 'silent',

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.11.0-alpha.8",
+    "version": "0.11.0",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -32,17 +32,22 @@
         "package.cjs"
     ],
     "dependencies": {
-        "@lwrjs/core": "0.11.0-alpha.8",
-        "esbuild": "^0.17.4"
+        "@lwrjs/config": "0.11.0",
+        "@lwrjs/core": "0.11.0",
+        "@lwrjs/diagnostics": "0.11.0",
+        "@lwrjs/shared-utils": "0.11.0",
+        "esbuild": "^0.17.4",
+        "fs-extra": "^11.1.1"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.11.0-alpha.8"
+        "@lwrjs/types": "0.11.0",
+        "mock-fs": "^5.2.0"
     },
     "peerDependencies": {
-        "lwc": "2.x || 3.x"
+        "lwc": "2.x || 3.x || 4.x"
     },
     "engines": {
         "node": ">=16.0.0"
     },
-    "gitHead": "bba3cfa996e84ee702f287e7e7b6361b807434db"
+    "gitHead": "fbc883ea90a12672ce6f1adc2201144fda8762bd"
 }