@oracle/oraclejet-icu-l10n 17.0.3 → 17.0.4

package/Bundler.js

@@ -275,7 +275,7 @@ function build({
       Object.assign(combinedBundle, perBundle);
       // combinedBundle should not have keys not in rootBundle
       if (rootBundleKeys) {
-        const extraKeys = Object.keys(combinedBundle).filter((k) => !rootBundleKeys.has(k));
+        const extraKeys = Object.keys(combinedBundle).filter((k) => !rootBundleKeys.has(k) && !k.startsWith('@'));
         if (extraKeys.length) {
           throw Error(`${perBundlePath} has keys not found in ${rootBundleFile}: ${extraKeys}`);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oracle/oraclejet-icu-l10n",
-  "version": "17.0.3",
+  "version": "17.0.4",
   "description": "JET ICU Message Format Parser",
   "main": "l10nBundleBuilder.js",
   "scripts": {

package/test/l10nTest.ts

@@ -6,7 +6,7 @@ import fsx from 'fs-extra';
 import vm from 'node:vm';
 import glob from 'glob';
 
-const rootDir = path.join(__dirname, 'resources/nls');
+const resourcesDir = path.join(__dirname, 'resources/nls');
 const outputRoot = path.resolve(__dirname, 'built');
 
 type ExportType = 'default' | 'named';
@@ -187,7 +187,7 @@ function runTestCases(extractBundle: (bundle: string) => any) {
       let didFail = false;
       try {
         build({
-          rootDir: path.join(`${rootDir}-bad-metadata`),
+          rootDir: path.join(`${resourcesDir}-bad-metadata`),
           locale: 'ro-MD',
           bundleName: 'app-strings-bad-root.json',
           outDir: path.join(outputRoot, 'nls-bad-metadata')
@@ -225,7 +225,7 @@ describe('Custom hooks', () => {
     const outDir = path.resolve(outputRoot, 'custom-hooks');
     fsx.removeSync(outDir);
     build({
-      rootDir,
+      rootDir: resourcesDir,
       bundleName: 'app-strings.json',
       locale: 'en-US',
       outDir,
@@ -244,7 +244,7 @@ describe('Custom hooks', () => {
     const outDir = path.resolve(outputRoot, 'custom-hooks-no-def');
     fsx.removeSync(outDir);
     build({
-      rootDir,
+      rootDir: resourcesDir,
       bundleName: 'app-strings.json',
       locale: 'en-US',
       outDir,
@@ -274,7 +274,7 @@ describe('CJS default export', () => {
 
   fsx.removeSync(outDir);
   build({
-    rootDir,
+    rootDir: resourcesDir,
     bundleName: 'app-strings.json',
     locale: 'en-US',
     outDir,
@@ -323,7 +323,7 @@ describe('AMD', () => {
 
     fsx.removeSync(outDir);
     build({
-      rootDir,
+      rootDir: resourcesDir,
       bundleName: 'app-strings.json',
       locale: 'en-US',
       outDir,
@@ -348,7 +348,7 @@ describe('AMD', () => {
     beforeAll(() => {
       fsx.removeSync(outDir);
       build({
-        rootDir,
+        rootDir: resourcesDir,
         bundleName: 'app-strings-legacy-keys.json',
         locale: 'en-US',
         outDir,
@@ -373,12 +373,12 @@ describe('Extra locales', () => {
   const outDir = path.resolve(outputRoot, 'extra');
   const additionalLocales = ['de', 'de-DE', 'fr-FR', 'ru', 'ru-RU'];
   const allLocales = [
-    ...new Set(fsx.readdirSync(rootDir).filter(isNlsDir).concat(additionalLocales).sort())
+    ...new Set(fsx.readdirSync(resourcesDir).filter(isNlsDir).concat(additionalLocales).sort())
   ];
 
   fsx.removeSync(outDir);
   build({
-    rootDir,
+    rootDir: resourcesDir,
     bundleName: 'app-strings.json',
     locale: 'en-US',
     outDir,
@@ -416,7 +416,7 @@ describe('Override files', () => {
 
   describe('with root overrides', () => {
     build({
-      rootDir,
+      rootDir: resourcesDir,
       bundleName: 'app-strings-x.json',
       locale: 'en-US',
       override: true,
@@ -463,7 +463,7 @@ describe('Override files', () => {
 
   describe('without root overrides', () => {
     build({
-      rootDir,
+      rootDir: resourcesDir,
       bundleName: 'extra-app-strings-x.json',
       override: true,
       locale: 'en-US',
@@ -488,12 +488,13 @@ describe('Override files', () => {
 
 describe('extra keys', () => {
   const outDir = path.resolve(outputRoot, 'extra-keys');
+  const extractBundle = (fp: string) => extractCjsBundle(outDir, fp).default;
 
   it('should fail if locale bundle has extra keys', () => {
     let didFail = false;
     try {
       build({
-        rootDir: `${rootDir}-extra-keys`,
+        rootDir: `${resourcesDir}-extra-keys`,
         bundleName: 'app-bundle-bad.json',
         locale: 'en-US',
         outDir
@@ -503,4 +504,16 @@ describe('extra keys', () => {
     }
     expect(didFail).toBeTruthy();
   });
+
+  it('should allow extra metadata keys', () => {
+    build({
+      rootDir: `${resourcesDir}-extra-metadata-keys`,
+      bundleName: 'app-bundle-metadata-keys.json',
+      locale: 'en-US',
+      outDir,
+      module: 'cjs'
+    });
+    const bundle = extractBundle('en/app-bundle-metadata-keys.js');
+    expect(bundle.welcome()).toEqual('Welcome');
+  });
 });

package/test/resources/nls-extra-keys/xm/app-bundle.json

@@ -0,0 +1,3 @@
+{
+  "@metadata-key": "This is a metadata key not found in the root, but should be excluded from the extra-keys check"
+}

package/test/resources/nls-extra-metadata-keys/app-bundle-metadata-keys.json

@@ -0,0 +1,4 @@
+{
+  "welcome": "Welcome",
+  "intro": "Intro"
+}

package/test/resources/nls-extra-metadata-keys/en/app-bundle-metadata-keys.json

@@ -0,0 +1,3 @@
+{
+  "@extra-metadata-key": "This is a metadata key not found in the root, and should pass the extra-keys check"
+}