@zohodesk/client_build_tool 0.0.11-exp.17.0 → 0.0.11-exp.18.0

package/lib/schemas/defaultConfigValues.js

@@ -193,6 +193,11 @@ var _default = {
     htmlTemplateLabel: '{{--user-locale}}',
     localeVarName: 'window.userLangCode',
     singleFile: false,
+    // When true, locales are restricted to keys present in base JSResources.properties
+    restrictToBaseKeys: {
+      value: false,
+      cli: 'i18n_restrict_to_base'
+    },
     includeContentHash: false,
     generateManifest: false,
     manifestPath: null,

package/lib/schemas/defaultConfigValuesOnly.js

@@ -109,6 +109,7 @@ var _default = {
     htmlTemplateLabel: '{{--user-locale}}',
     localeVarName: 'window.userLangCode',
     singleFile: false,
+    restrictToBaseKeys: false,
     includeContentHash: false,
     generateManifest: false,
     manifestPath: null,

package/lib/shared/bundler/webpack/custom_plugins/I18nNumericIndexPlugin/I18nGroupRuntimeModule.js

@@ -29,7 +29,6 @@ class I18nGroupRuntimeModule extends _webpack.RuntimeModule {
     return `
     // I18n Group Loading Runtime
     (function() {
-      console.log('[I18n Runtime] Initializing i18n group loader with groups:', ${JSON.stringify(chunkToGroup)});
       var loadedGroups = {};
       var chunkToGroup = ${JSON.stringify(chunkToGroup)};
       
@@ -52,7 +51,6 @@ class I18nGroupRuntimeModule extends _webpack.RuntimeModule {
             .replace('[locale]', locale)
             .replace('i18n-chunk/', __webpack_require__.p + 'i18n-chunk/');
           
-          console.log('[I18n Runtime] Loading i18n group:', groupName, 'from:', i18nUrl);
           
           var script = document.createElement('script');
           script.src = i18nUrl;
@@ -60,12 +58,10 @@ class I18nGroupRuntimeModule extends _webpack.RuntimeModule {
           
           script.onload = function() {
             loadedGroups[groupName] = true;
-            console.log('[I18n Runtime] Successfully loaded i18n group:', groupName);
             resolve();
           };
           
           script.onerror = function() {
-            console.error('[I18n Runtime] Failed to load i18n group:', groupName);
             reject(new Error('Failed to load i18n group: ' + groupName));
           };
           
@@ -84,7 +80,6 @@ class I18nGroupRuntimeModule extends _webpack.RuntimeModule {
         // Check if this chunk needs an i18n group
         var groupName = chunkToGroup[chunkId];
         if (groupName && !loadedGroups[groupName]) {
-          console.log('[I18n Runtime] Chunk', chunkId, 'requires i18n group:', groupName);
           // Load the i18n group before the chunk
           var i18nPromise = loadI18nGroup(groupName);
           // Chain the promises so i18n loads first

package/lib/shared/bundler/webpack/custom_plugins/I18nNumericIndexPlugin/I18nNumericIndexHtmlInjectorPlugin.js

@@ -19,7 +19,6 @@ class I18nNumericIndexHtmlInjectorPlugin {
       HtmlWebpackPlugin.getHooks(compilation).beforeAssetTagGeneration.tapAsync(pluginName, (hookData, cb) => {
         // Skip HTML injection if injectI18nUrlInIndex is false
         if (!this.options.injectI18nUrlInIndex) {
-          console.log('[I18nNumericIndexHtmlInjectorPlugin] Skipping HTML injection (injectI18nUrlInIndex is false)');
           return cb(null, hookData);
         }
 

package/lib/shared/bundler/webpack/custom_plugins/I18nNumericIndexPlugin/I18nNumericIndexPlugin.js

@@ -26,7 +26,6 @@ const pluginName = 'I18nNumericIndexPlugin';
 
 class I18nNumericIndexPlugin {
   constructor(options) {
-    console.log('[I18nNumericIndexPlugin] Plugin initialized with options:', JSON.stringify(options, null, 2));
     this.options = { ...options,
       singleFile: options.singleFile || false,
       singleFileTemplate: options.singleFileTemplate || '[locale].js',
@@ -34,8 +33,7 @@ class I18nNumericIndexPlugin {
       generateManifest: options.generateManifest || false,
       outputFolder: options.outputFolder || 'i18n-chunk',
       manifestPath: options.manifestPath || null,
-      emitFiles: options.emitFiles !== undefined ? options.emitFiles : true // Default to true for backward compatibility
-
+      emitFiles: options.emitFiles !== undefined ? options.emitFiles : true
     };
     this.numericMap = {};
     this.customGroups = {};
@@ -48,11 +46,9 @@ class I18nNumericIndexPlugin {
     compiler.hooks.thisCompilation.tap(pluginName, compilation => {
       // Add runtime module for group-based loading
       if (this.options.customGroups) {
-        // Add runtime module unconditionally to ensure it's always available
         compilation.hooks.additionalTreeRuntimeRequirements.tap(pluginName, (chunk, set) => {
           // Only add to the main/entry chunk to avoid duplication
           if (chunk.name === 'main' || chunk.hasRuntime()) {
-            console.log('[I18nNumericIndexPlugin] Adding I18nGroupRuntimeModule to chunk:', chunk.name || chunk.id);
             compilation.addRuntimeModule(chunk, new _I18nGroupRuntimeModule.I18nGroupRuntimeModule({
               customGroups: this.options.customGroups,
               localeVarName: this.options.localeVarName,
@@ -104,7 +100,6 @@ class I18nNumericIndexPlugin {
   }
 
   processI18nFiles(compilation) {
-    console.log('[I18nNumericIndexPlugin] Starting to process i18n files - plugin is active');
     const {
       jsResourcePath,
       propertiesFolderPath,
@@ -116,7 +111,6 @@ class I18nNumericIndexPlugin {
     } = this.options;
 
     if (!jsResourcePath || !propertiesFolderPath) {
-      console.log('[I18nNumericIndexPlugin] Missing required paths - jsResourcePath:', jsResourcePath, 'propertiesFolderPath:', propertiesFolderPath);
       return;
     } // Load existing numeric map if available
 
@@ -135,7 +129,8 @@ class I18nNumericIndexPlugin {
     } // Read JSResources.properties
 
 
-    const jsResourceKeys = (0, _propertiesUtils.getPropertiesAsJSON)(jsResourcePath); // Parse custom groups from banner markers
+    let jsResourceKeys = (0, _propertiesUtils.getPropertiesAsJSON)(jsResourcePath);
+    jsResourceKeys = this.normalizeObjectValues(jsResourceKeys); // Parse custom groups from banner markers
 
     if (customGroups) {
       this.parseCustomGroups(jsResourcePath, customGroups);
@@ -146,6 +141,10 @@ class I18nNumericIndexPlugin {
       folderPath: propertiesFolderPath,
       disableDefault: false,
       jsResourceI18nKeys: jsResourceKeys
+    }); // Normalize locale values
+
+    Object.keys(allI18nObject).forEach(loc => {
+      allI18nObject[loc] = this.normalizeObjectValues(allI18nObject[loc]);
     }); // For en_US, use only JSResources (don't merge with ApplicationResources_en_US)
 
     if (allI18nObject['en_US']) {
@@ -153,6 +152,21 @@ class I18nNumericIndexPlugin {
     } else {
       // If en_US doesn't exist in the folder, create it from JSResources
       allI18nObject['en_US'] = jsResourceKeys;
+    } // If requested, restrict all locales to base (English) keys only
+
+
+    if (this.options.restrictToBaseKeys) {
+      const baseKeys = Object.keys(jsResourceKeys);
+      Object.keys(allI18nObject).forEach(locale => {
+        const merged = { ...jsResourceKeys,
+          ...allI18nObject[locale]
+        };
+        const filtered = {};
+        baseKeys.forEach(k => {
+          filtered[k] = merged[k];
+        });
+        allI18nObject[locale] = filtered;
+      });
     }
 
     const locales = Object.keys(allI18nObject); // Process each locale
@@ -315,9 +329,8 @@ class I18nNumericIndexPlugin {
   emitChunk(compilation, filenameTemplate, locale, data, jsonpFunc, groupName = null, fileType = null) {
     if (!filenameTemplate || Object.keys(data).length === 0) {
       return null;
-    }
+    } // Generate content regardless of emitFiles flag (needed for runtime)
 
-    console.log('[I18nNumericIndexPlugin] Processing chunk for locale:', locale, 'fileType:', fileType, 'dataKeys:', Object.keys(data).length, 'groupName:', groupName, 'emitFiles:', this.options.emitFiles); // Generate content regardless of emitFiles flag (needed for runtime)
 
     const content = this.generateChunkContent(data, jsonpFunc, groupName);
     let outputPath = this.constructFilePath(filenameTemplate, locale); // Handle [contenthash] placeholder in template
@@ -350,10 +363,7 @@ class I18nNumericIndexPlugin {
 
 
     if (this.options.emitFiles) {
-      console.log('[I18nNumericIndexPlugin] Emitting file:', outputPath);
       compilation.emitAsset(outputPath, new RawSource(content));
-    } else {
-      console.log('[I18nNumericIndexPlugin] Skipping file emission for:', outputPath, '(emitFiles is false)');
     }
 
     return outputPath;
@@ -371,6 +381,19 @@ class I18nNumericIndexPlugin {
     return `${jsonpFunc}(${jsonString});`;
   }
 
+  normalizeValue(value) {
+    if (typeof value !== 'string') return value;
+    return value.replace(/\\t/g, '\t').replace(/\\n/g, '\n').replace(/\\r/g, '\r').replace(/\\f/g, '\f').replace(/\\:/g, ':').replace(/\\=/g, '=').replace(/\\ /g, ' ');
+  }
+
+  normalizeObjectValues(obj) {
+    const out = {};
+    Object.keys(obj || {}).forEach(k => {
+      out[k] = this.normalizeValue(obj[k]);
+    });
+    return out;
+  }
+
 }
 
 exports.default = I18nNumericIndexPlugin;

package/lib/shared/bundler/webpack/loaderConfigs/i18nIdReplaceLoaderConfig.js

@@ -3,10 +3,8 @@
 const {
   getPropertiesAsJSON
 } = require('../custom_plugins/I18nSplitPlugin/utils/propertiesUtils');
-/**
- * Load i18n data from JSResources file once for all chunks
- */
 
+const fs = require('fs');
 
 function loadJSResourcesOnce(options) {
   let jsResourcePath; // Determine the JSResource path based on configuration
@@ -36,10 +34,20 @@ function loadJSResourcesOnce(options) {
     throw new Error(`Error reading JSResource file ${jsResourcePath}: ${err.message}`);
   }
 }
-/**
- * Configure the i18n ID replace loader
- */
 
+function readNumericMapOnce(numericMapPath) {
+  if (!numericMapPath) return null;
+
+  try {
+    if (!fs.existsSync(numericMapPath)) return null;
+    const fileContent = fs.readFileSync(numericMapPath, 'utf-8');
+    const parsed = JSON.parse(fileContent);
+    if (!parsed) return null;
+    return parsed.originalKeyToNumericId ? parsed.originalKeyToNumericId : parsed;
+  } catch (err) {
+    return null;
+  }
+}
 
 function i18nIdReplaceLoaderConfig(options, webpackContext) {
   let numericMapPath; // Determine the numeric map path based on configuration
@@ -61,10 +69,12 @@ function i18nIdReplaceLoaderConfig(options, webpackContext) {
 
   const i18nKeyReplaceLoaderPath = require.resolve('../loaders/i18nIdReplaceLoader.js');
 
+  const numericIdMap = readNumericMapOnce(numericMapPath);
   const loaderOptions = {
     allI18nData: allI18nData,
     sourceMaps: false,
     numericMapPath: numericMapPath,
+    numericIdMap: numericIdMap || undefined,
     devMode: options.i18nIndexing?.devMode || false,
     includePaths: options.i18nIndexing?.loaderOptions?.includePaths || [],
     excludePaths: options.i18nIndexing?.loaderOptions?.excludePaths || ['node_modules', 'tests']

package/lib/shared/bundler/webpack/loaders/i18nIdReplaceLoader.js

@@ -20,7 +20,16 @@ module.exports = function i18nIdReplaceLoader(source, map) {
   const resourcePath = this.resourcePath;
   this.cacheable && this.cacheable();
   const options = getOptions(this) || {};
-  const callback = this.async(); // Skip files in excluded paths
+  const callback = this.async();
+  let numericMapAbsPath = null;
+
+  if (options.numericMapPath) {
+    try {
+      numericMapAbsPath = path.isAbsolute(options.numericMapPath) ? options.numericMapPath : path.resolve(this.rootContext || this.context || process.cwd(), options.numericMapPath);
+      this.addDependency(numericMapAbsPath);
+    } catch (e) {}
+  } // Skip files in excluded paths
+
 
   if (options.excludePaths) {
     const shouldExclude = options.excludePaths.some(excludePath => resourcePath.includes(excludePath));
@@ -42,29 +51,46 @@ module.exports = function i18nIdReplaceLoader(source, map) {
 
   if (!options.allI18nData || Object.keys(options.allI18nData).length === 0) {
     return callback(new Error(`i18nIdReplaceLoader: 'allI18nData' option is missing or empty`));
-  } // Load numeric ID mapping
+  } // Load numeric ID mapping (use injected map if provided; fallback to memoized file read)
 
 
-  let numericIdMap = null;
+  let numericIdMap = options.numericIdMap || null;
 
-  if (options.numericMapPath) {
-    try {
-      if (fs.existsSync(options.numericMapPath)) {
-        const fileContent = fs.readFileSync(options.numericMapPath, 'utf-8');
-        const parsedData = JSON.parse(fileContent); // Handle both wrapped and flat formats
-
-        if (parsedData) {
-          if (parsedData.originalKeyToNumericId) {
-            // New format with wrapper
-            numericIdMap = parsedData.originalKeyToNumericId;
-          } else if (typeof parsedData === 'object') {
-            // Flat format - use directly
-            numericIdMap = parsedData;
+  try {
+    if (!numericIdMap && (numericMapAbsPath || options.numericMapPath)) {
+      // Module-level static cache
+      if (!global.__CBT_I18N_NUMERIC_MAP_CACHE__) {
+        global.__CBT_I18N_NUMERIC_MAP_CACHE__ = {};
+      }
+
+      const cache = global.__CBT_I18N_NUMERIC_MAP_CACHE__;
+      const p = numericMapAbsPath || options.numericMapPath;
+
+      try {
+        const stat = fs.statSync(p);
+        const key = `${p}`;
+        const mtime = stat && stat.mtimeMs ? stat.mtimeMs : 0;
+        const hit = cache[key];
+
+        if (hit && hit.mtime === mtime && hit.map) {
+          numericIdMap = hit.map;
+        } else if (fs.existsSync(p)) {
+          const txt = fs.readFileSync(p, 'utf-8');
+          const parsed = JSON.parse(txt);
+          const mapObj = parsed && parsed.originalKeyToNumericId ? parsed.originalKeyToNumericId : parsed;
+
+          if (mapObj && typeof mapObj === 'object') {
+            cache[key] = {
+              mtime,
+              map: mapObj
+            };
+            numericIdMap = mapObj;
           }
         }
+      } catch (e) {// ignore and proceed without map
       }
-    } catch (err) {// Silently continue without numeric mapping
     }
+  } catch (e) {// ignore
   } // If no numeric map available, return source as-is
 
 

package/lib/shared/bundler/webpack/pluginConfigs/configI18nNumericIndexPlugin.js

@@ -11,8 +11,6 @@ var _I18nNumericIndexHtmlInjectorPlugin = require("../custom_plugins/I18nNumeric
 
 var _readI18nValues = require("../custom_plugins/I18nSplitPlugin/readI18nValues");
 
-var _path = _interopRequireDefault(require("path"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function configI18nNumericIndexPlugin(options) {
@@ -22,7 +20,17 @@ function configI18nNumericIndexPlugin(options) {
 
   const i18nOpts = options.i18nIndexing;
   const isDevelopment = options.isDevelopment || false; // Get isDevelopment from options
-  // Validate required options
+  // If we are only doing numeric ID replacement (no files to emit and no HTML injection, and no custom groups),
+  // we can skip creating plugin instances to save build time.
+
+  const emitFiles = i18nOpts.emitFiles !== undefined ? i18nOpts.emitFiles : true;
+  const injectHtml = i18nOpts.injectI18nUrlInIndex !== undefined ? i18nOpts.injectI18nUrlInIndex : true;
+  const hasCustomGroups = !!(i18nOpts.customGroups && Object.keys(i18nOpts.customGroups || {}).length);
+
+  if (!emitFiles && !injectHtml && !hasCustomGroups) {
+    return [];
+  } // Validate required options
+
 
   const requiredOptions = ['jsResourcePath', 'propertiesFolderPath', 'numericMapPath', 'jsonpFunc', 'htmlTemplateLabel', 'localeVarName'];
   const missingOptions = requiredOptions.filter(opt => !i18nOpts[opt]);
@@ -77,14 +85,13 @@ function configI18nNumericIndexPlugin(options) {
     jsonpFunc: i18nOpts.jsonpFunc,
     localeVarName: i18nOpts.localeVarName,
     singleFile: i18nOpts.singleFile || false,
+    restrictToBaseKeys: i18nOpts.restrictToBaseKeys || false,
     includeContentHash: i18nOpts.includeContentHash || false,
     generateManifest: i18nOpts.generateManifest || false,
     manifestPath: i18nOpts.manifestPath || null,
     customGroups: i18nOpts.customGroups || null,
     emitFiles: i18nOpts.emitFiles !== undefined ? i18nOpts.emitFiles : true,
-    // Control file emission
-    isDevelopment: isDevelopment // Pass through for reference
-
+    isDevelopment: isDevelopment
   }; // HTML injector options
 
   const htmlInjectorOptions = {
@@ -95,7 +102,6 @@ function configI18nNumericIndexPlugin(options) {
     htmlTemplateLabel: i18nOpts.htmlTemplateLabel,
     singleFile: i18nOpts.singleFile || false,
     i18nAssetsPublicPathPrefix: '',
-    // HtmlWebpackPlugin handles publicPath
     injectI18nUrlInIndex: i18nOpts.injectI18nUrlInIndex !== undefined ? i18nOpts.injectI18nUrlInIndex : true,
     // Control HTML injection
     isDevelopment: isDevelopment

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@zohodesk/client_build_tool",
-  "version": "0.0.11-exp.16.0",
+  "version": "0.0.11-exp.17.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@zohodesk/client_build_tool",
-      "version": "0.0.11-exp.16.0",
+      "version": "0.0.11-exp.17.0",
       "license": "ISC",
       "dependencies": {
         "@babel/cli": "7.17.10",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/client_build_tool",
-  "version": "0.0.11-exp.17.0",
+  "version": "0.0.11-exp.18.0",
   "description": "A CLI tool to  build  web applications and client libraries",
   "main": "lib/index.js",
   "bin": {

package/example-single-file-config.js

@@ -1,59 +0,0 @@
-// Example configuration for single-file i18n mode
-// When singleFile is true, output will be: i18n/en_US.js, i18n/fr_FR.js, etc.
-
-module.exports = {
-  i18nIndexing: {
-    enable: true,
-    
-    // Output folder for all i18n files
-    outputFolder: 'i18n',
-    
-    // Input paths
-    jsResourcePath: './resources/ApplicationResources.properties',
-    propertiesFolderPath: './resources',
-    numericMapPath: './numericMap.json',
-    
-    // Single-file mode configuration
-    singleFile: true,
-    singleFileTemplate: '[locale].js',  // Will create: i18n/en_US.js, i18n/fr_FR.js, etc.
-    
-    // These are ignored in single-file mode but kept for backward compatibility
-    numericFilenameTemplate: '[locale]/numeric.i18n.js',
-    dynamicFilenameTemplate: '[locale]/dynamic.i18n.js',
-    
-    // Runtime configuration
-    jsonpFunc: 'window.loadI18n',
-    htmlTemplateLabel: '{{--user-locale}}',
-    localeVarName: 'window.userLangCode',
-    
-    // Optimization options
-    includeContentHash: true,  // Will add hash: i18n/en_US.abc123.js
-    generateManifest: true,
-    manifestPath: 'i18n/manifest.json',  // Custom manifest location
-    
-    // Loader options
-    loaderOptions: {
-      includePaths: ['src'],
-      excludePaths: ['node_modules', 'tests']
-    }
-  }
-};
-
-/* 
-Output structure with these settings:
-
-build/
-├── i18n/
-│   ├── en_US.abc123.js      # Combined numeric + dynamic keys with content hash
-│   ├── fr_FR.def456.js      
-│   ├── de_DE.ghi789.js
-│   └── manifest.json         # Maps original names to hashed versions
-└── index.html                # HTML with injected script tag for locale
-
-Manifest content example:
-{
-  "i18n/en_US.js": "en_US.abc123.js",
-  "i18n/fr_FR.js": "fr_FR.def456.js",
-  "i18n/de_DE.js": "de_DE.ghi789.js"
-}
-*/

package/packages/client_build_tool/test-i18n-config.js

@@ -1,22 +0,0 @@
-// Test configuration for i18n indexing features
-module.exports = {
-  i18nIndexing: {
-    enable: true,
-    outputFolder: 'i18n',  // Changed from default 'i18n-chunk'
-    jsResourcePath: './test-data/JSResources.properties',
-    propertiesFolderPath: './test-data/properties',
-    numericMapPath: './test-data/i18n-numeric-map.json',
-    numericFilenameTemplate: '[locale]/numeric.js',
-    dynamicFilenameTemplate: '[locale]/dynamic.js',
-    jsonpFunc: 'window.loadI18n',
-    htmlTemplateLabel: '{{locale}}',
-    localeVarName: 'window.userLocale',
-    singleFile: false,
-    includeContentHash: true,  // Enable content hashing
-    generateManifest: true,     // Enable manifest generation
-    loaderOptions: {
-      includePaths: ['src'],
-      excludePaths: ['node_modules', 'tests', 'lib']
-    }
-  }
-};