@o3r/localization 9.4.0-alpha.8 → 9.5.0-alpha.1

package/builders/helpers/localization.generator.d.ts

@@ -1,5 +1,6 @@
 import { logging } from '@angular-devkit/core';
 import type { JSONLocalization, LocalizationMetadata } from '@o3r/localization';
+import type { LocalizationExtractorBuilderSchema } from '../localization-extractor/schema';
 /** Map of Localization Metadata base on localization key */
 export interface LocalizationMetadataAsMap {
     [key: string]: JSONLocalization;
@@ -38,10 +39,11 @@ export interface LibraryMetadataMap {
  * Localization extractor
  */
 export declare class LocalizationExtractor {
+    private options?;
     /** TsConfig of the file to base on */
     private tsconfigPath;
     private logger;
-    constructor(tsconfigPath: string, logger: logging.LoggerApi);
+    constructor(tsconfigPath: string, logger: logging.LoggerApi, options?: Partial<LocalizationExtractorBuilderSchema> | undefined);
     /** Get the list of file from tsconfig.json */
     private getFilesFromTsConfig;
     /**
@@ -50,13 +52,6 @@ export declare class LocalizationExtractor {
      * @param source Ts file source
      */
     private getAngularClassNode;
-    /**
-     * Retrieve the localization json file from TS Code
-     *
-     * @param node TSNode of the angular component class
-     * @param source Ts file source
-     */
-    private getLocalizationFileFromAngularElement;
     /**
      * Get the list of referenced translation files
      *

package/builders/helpers/localization.generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"localization.generator.d.ts","sourceRoot":"","sources":["../../../builders/helpers/localization.generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAUhF,4DAA4D;AAC5D,MAAM,WAAW,yBAAyB;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;CACjC;AAED,6BAA6B;AAC7B,MAAM,WAAW,qBAAqB;IACpC,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iDAAiD;IACjD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,iCAAiC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,kCAAkC;AAClC,MAAM,WAAW,oBAAoB;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAC;CACtC;AAED,gCAAgC;AAChC,MAAM,WAAW,mBAAmB;IAClC,CAAC,IAAI,EAAE,MAAM,GAAG;QACd,IAAI,EAAE,oBAAoB,CAAC;QAC3B,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED,4BAA4B;AAC5B,MAAM,WAAW,kBAAkB;IACjC,CAAC,mBAAmB,EAAE,MAAM,GAAG,oBAAoB,CAAC;CACrD;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAEhC,sCAAsC;IACtC,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,MAAM,CAAoB;gBAEtB,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,SAAS;IAK3D,8CAA8C;IAC9C,OAAO,CAAC,oBAAoB;IAK5B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IA4B3B;;;;;OAKG;IACH,OAAO,CAAC,qCAAqC;IAyB7C;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IA0B1B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAIxB;;;;;OAKG;IACH,OAAO,CAAC,oCAAoC;IA4B5C;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAYnB,kDAAkD;IAC3C,uBAAuB;;;;;IAc9B;;;;;;OAMG;IACU,kBAAkB,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAE,kBAAkB,GAAE,MAAM,EAAO,EAAE,YAAY,UAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA2BnJ;;;;OAIG;IACU,+BAA+B,CAAC,sBAAsB,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA8BjH;;;;OAIG;IACU,wBAAwB,CAAC,SAAS,EAAE,MAAM,EAAE;IAQzD;;;;OAIG;IACU,oBAAoB,CAAC,aAAa,EAAE,MAAM,EAAE;IASzD;;;;;;;;;OASG;IACI,gBAAgB,CAAC,eAAe,EAAE,mBAAmB,EAAE,OAAO,EAAE;QACrE,mBAAmB,EAAE,OAAO,CAAC;QAC7B,eAAe,EAAE,kBAAkB,CAAC;QACpC,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,OAAO,CAAC;KACnB,GAAG,oBAAoB;CAkCzB"}
+{"version":3,"file":"localization.generator.d.ts","sourceRoot":"","sources":["../../../builders/helpers/localization.generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAMhF,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,kCAAkC,CAAC;AAK3F,4DAA4D;AAC5D,MAAM,WAAW,yBAAyB;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;CACjC;AAED,6BAA6B;AAC7B,MAAM,WAAW,qBAAqB;IACpC,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iDAAiD;IACjD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,iCAAiC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,kCAAkC;AAClC,MAAM,WAAW,oBAAoB;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAC;CACtC;AAED,gCAAgC;AAChC,MAAM,WAAW,mBAAmB;IAClC,CAAC,IAAI,EAAE,MAAM,GAAG;QACd,IAAI,EAAE,oBAAoB,CAAC;QAC3B,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED,4BAA4B;AAC5B,MAAM,WAAW,kBAAkB;IACjC,CAAC,mBAAmB,EAAE,MAAM,GAAG,oBAAoB,CAAC;CACrD;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAO6B,OAAO,CAAC,OAAO,CAAC;IAL7E,sCAAsC;IACtC,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,MAAM,CAAoB;gBAEtB,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,SAAS,EAAU,OAAO,CAAC,yDAA6C;IAK1H,8CAA8C;IAC9C,OAAO,CAAC,oBAAoB;IAK5B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IA4B3B;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IA8B1B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAIxB;;;;;OAKG;IACH,OAAO,CAAC,oCAAoC;IAiC5C;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAYnB,kDAAkD;IAC3C,uBAAuB;;;;;IAc9B;;;;;;OAMG;IACU,kBAAkB,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAE,kBAAkB,GAAE,MAAM,EAAO,EAAE,YAAY,UAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA2BnJ;;;;OAIG;IACU,+BAA+B,CAAC,sBAAsB,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA8BjH;;;;OAIG;IACU,wBAAwB,CAAC,SAAS,EAAE,MAAM,EAAE;IAQzD;;;;OAIG;IACU,oBAAoB,CAAC,aAAa,EAAE,MAAM,EAAE;IASzD;;;;;;;;;OASG;IACI,gBAAgB,CAAC,eAAe,EAAE,mBAAmB,EAAE,OAAO,EAAE;QACrE,mBAAmB,EAAE,OAAO,CAAC;QAC7B,eAAe,EAAE,kBAAkB,CAAC;QACpC,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,OAAO,CAAC;KACnB,GAAG,oBAAoB;CAsDzB"}

package/builders/helpers/localization.generator.js

@@ -13,7 +13,8 @@ const ANGULAR_ANNOTATION = ['Component', 'Injectable', 'Pipe'];
  * Localization extractor
  */
 class LocalizationExtractor {
-    constructor(tsconfigPath, logger) {
+    constructor(tsconfigPath, logger, options) {
+        this.options = options;
         this.tsconfigPath = tsconfigPath;
         this.logger = logger;
     }
@@ -51,32 +52,6 @@ class LocalizationExtractor {
         });
         return angularItems.length ? angularItems : undefined;
     }
-    /**
-     * Retrieve the localization json file from TS Code
-     *
-     * @param node TSNode of the angular component class
-     * @param source Ts file source
-     */
-    getLocalizationFileFromAngularElement(node, source) {
-        const localizationPaths = [];
-        node.forEachChild((item) => {
-            if (!ts.isPropertyDeclaration(item)) {
-                return;
-            }
-            item.forEachChild((decorator) => {
-                if (!ts.isDecorator(decorator)) {
-                    return;
-                }
-                const text = decorator.getText(source);
-                const result = /^@Localization *\( *['"](.*)['"] *\)/.exec(text);
-                if (!result || !result[1]) {
-                    return;
-                }
-                localizationPaths.push(result[1]);
-            });
-        });
-        return localizationPaths.length ? localizationPaths : undefined;
-    }
     /**
      * Get the list of referenced translation files
      *
@@ -97,15 +72,19 @@ class LocalizationExtractor {
         })
             .map(({ ref }) => {
             if (!ref.startsWith('.')) {
-                try {
-                    return require.resolve(ref);
-                }
-                catch {
-                    // Should be a local file
+                if (this.options?.libraries?.length && this.options.libraries.every((lib) => !ref.startsWith(lib))) {
+                    try {
+                        return require.resolve(ref);
+                    }
+                    catch {
+                        // Should be a local file
+                    }
                 }
+                return undefined;
             }
             return folder ? path.resolve(folder, ref) : ref;
-        });
+        })
+            .filter((ref) => !!ref);
         return referencedFiles.length ? referencedFiles : undefined;
     }
     /**
@@ -144,7 +123,13 @@ class LocalizationExtractor {
             res.tags = loc.tags;
         }
         if (loc.$ref) {
-            res.ref = loc.$ref.split('#/')[1];
+            const [refPath, refKey] = loc.$ref.split('#/', 2);
+            if (this.options?.libraries?.some((lib) => refPath.startsWith(lib))) {
+                res.ref = refKey;
+            }
+            else {
+                res.ref = loc.$ref;
+            }
         }
         if (typeof loc.defaultValue === 'undefined' && typeof loc.$ref === 'undefined' && !loc.dictionary) {
             this.logger.error(`${key} has no default value or $ref defined`);
@@ -225,9 +210,9 @@ class LocalizationExtractor {
         const localizationFiles = tsFiles
             .map((file) => ({ file, source: program.getSourceFile(file) }))
             .map(({ file, source }) => ({ file, classes: source && this.getAngularClassNode(source), source }))
-            .filter(({ classes, source }) => !!classes && !!source)
-            .map(({ file, classes, source }) => classes
-            .map((classItem) => this.getLocalizationFileFromAngularElement(classItem, source))
+            .filter(({ classes }) => !!classes)
+            .map(({ file, classes }) => classes
+            .map((classItem) => (0, extractors_1.getLocalizationFileFromAngularElement)(classItem))
             .filter((locFiles) => !!locFiles)
             .reduce((acc, locFiles) => {
             acc.push(...locFiles.filter((f) => acc.indexOf(f) === -1));
@@ -276,24 +261,41 @@ class LocalizationExtractor {
      */
     generateMetadata(localizationMap, options) {
         const metadata = {};
-        const addMetadata = (data, origin) => {
+        let hasDuplicateKey = false;
+        const addMetadata = (data, origin, libraries = []) => {
             if (metadata[data.key]) {
+                hasDuplicateKey = true;
                 if (options.ignoreDuplicateKeys) {
                     this.logger.warn(`The key ${data.key} from ${origin} will override the previous value (${metadata[data.key].value || 'ref ' + metadata[data.key].ref} -> ${data.value || 'ref ' + data.ref})`);
                 }
                 else {
                     this.logger.error(`The key ${data.key} from ${origin} try to override the previous value (${metadata[data.key].value || 'ref ' + metadata[data.key].ref} -> ${data.value || 'ref ' + data.ref})`);
-                    throw new schematics_1.O3rCliError('Duplicate key');
                 }
             }
-            metadata[data.key] = data;
+            metadata[data.key] = data.ref && data.ref.includes('#/') && libraries.some((lib) => data.ref.startsWith(lib)) ? {
+                ...data,
+                ref: data.ref.split('#/')[1]
+            } : data;
         };
         Object.keys(options.libraryMetadata)
-            .forEach((lib) => options.libraryMetadata[lib].forEach((dataLoc) => addMetadata(dataLoc, lib)));
+            .forEach((lib) => options.libraryMetadata[lib].forEach((dataLoc) => addMetadata(dataLoc, lib, this.options?.libraries)));
         Object.keys(localizationMap)
             .forEach((locFile) => Object.keys(localizationMap[locFile].data)
             .forEach((locKey) => addMetadata(this.generateMetadataItemFromLocalization(localizationMap[locFile].data[locKey], locKey), locFile)));
-        const localizationMetadata = Object.keys(metadata).map((k) => metadata[k]);
+        if (hasDuplicateKey && !options.ignoreDuplicateKeys) {
+            throw new schematics_1.O3rCliError('Duplicate key');
+        }
+        const localizationMetadata = Object.values(metadata);
+        let hasUnknownRef = false;
+        localizationMetadata.forEach((data) => {
+            if (data.ref && !data.ref.includes('#/') && !metadata[data.ref]) {
+                hasUnknownRef = true;
+                this.logger.error(`The key ${data.ref} is unknown but referenced by ${data.key}.`);
+            }
+        });
+        if (hasUnknownRef) {
+            throw new schematics_1.O3rCliError('Unknown referenced key');
+        }
         return options.sortKeys ? localizationMetadata.sort((a, b) => this.compareKeys(a, b)) : localizationMetadata;
     }
 }

package/builders/localization-extractor/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../builders/localization-extractor/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,kCAAkC,EAAE,MAAM,UAAU,CAAC;AAI9D,cAAc,UAAU,CAAC;;AAEzB,wBA4LG"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../builders/localization-extractor/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,kCAAkC,EAAE,MAAM,UAAU,CAAC;AAG9D,cAAc,UAAU,CAAC;;AAEzB,wBA2LG"}

package/builders/localization-extractor/index.js

@@ -12,7 +12,7 @@ const validations_1 = require("./validations");
 tslib_1.__exportStar(require("./schema"), exports);
 exports.default = (0, architect_1.createBuilder)(async (options, context) => {
     context.reportRunning();
-    const localizationExtractor = new localization_generator_1.LocalizationExtractor(path.resolve(context.workspaceRoot, options.tsConfig), context.logger);
+    const localizationExtractor = new localization_generator_1.LocalizationExtractor(path.resolve(context.workspaceRoot, options.tsConfig), context.logger, options);
     const cache = { libs: {}, locs: {} };
     const execute = async (isFirstLoad = true, files) => {
         /** Maximum number of steps */
@@ -95,7 +95,6 @@ exports.default = (0, architect_1.createBuilder)(async (options, context) => {
     };
     /**
      * Run a translation generation and report the result
-     *
      * @param execution Execution process
      */
     const generateWithReport = async (execution) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o3r/localization",
-  "version": "9.4.0-alpha.8",
+  "version": "9.5.0-alpha.1",
   "description": "This module provides a runtime dynamic language/translation support and debug tools.",
   "keywords": [
     "localization",
@@ -18,13 +18,13 @@
     "@angular/core": "~16.2.0",
     "@angular/platform-browser-dynamic": "~16.2.0",
     "@formatjs/intl-numberformat": "^8.0.2",
-    "@ngrx/store": "~16.2.0",
+    "@ngrx/store": "~16.3.0",
     "@ngx-translate/core": "~15.0.0",
-    "@o3r/core": "^9.4.0-alpha.8",
-    "@o3r/dynamic-content": "^9.4.0-alpha.8",
-    "@o3r/extractors": "^9.4.0-alpha.8",
-    "@o3r/logger": "^9.4.0-alpha.8",
-    "@o3r/schematics": "^9.4.0-alpha.8",
+    "@o3r/core": "^9.5.0-alpha.1",
+    "@o3r/dynamic-content": "^9.5.0-alpha.1",
+    "@o3r/extractors": "^9.5.0-alpha.1",
+    "@o3r/logger": "^9.5.0-alpha.1",
+    "@o3r/schematics": "^9.5.0-alpha.1",
     "@schematics/angular": "~16.2.0",
     "chokidar": "^3.5.2",
     "intl-messageformat": "~10.5.0",