@oracle/oraclejet-icu-l10n 17.0.1 → 17.0.3

package/Bundler.d.ts

@@ -10,13 +10,14 @@
  * @param {string} props.rootDir The path to the root message bundle
  * @param {string} props.bundleName The name of the bundle file
  * @param {string} props.locale The locale of the root message bundle
- * @param {string} props.outDir The target directory where the compiled root message
- * @param {string=} props.module The type of module to produce -- 'esm', 'amd', or 'legacy-amd'
- * @param {string=} props.exportType The type of export to produce -- 'default' or 'named'
+ * @param {string} props.outDir The output directory where the built bundle will be written
+ * @param {('amd'|'cjs'|'esm'|'legacy-amd')=} props.module The type of module to produce -- 'amd', 'cjs', 'esm', or 'legacy-amd'.
+ * If not supplied, the Typscript will not be transpiled.
+ * @param {('default'|'named')=} props.exportType The type of export to produce -- 'default' or 'named'
  * @param {boolean=} props.override Indicates the bundle is an override, and only the root
  * locale and those explicitly stated in [--supportedLocales] will be built.
  * @param {string[]=} props.additionalLocales An array of additional locales to build
- * @param {string=} hooks A path to the custom hooks file
+ * @param {string=} props.hooks A path to the custom hooks file
  */
 export function build({
   rootDir,
@@ -33,10 +34,11 @@ export function build({
   bundleName: string;
   locale: string;
   outDir: string;
-  module?: string | undefined;
-  exportType?: string | undefined;
+  module?: ('amd' | 'cjs' | 'esm' | 'legacy-amd') | undefined;
+  exportType?: ('default' | 'named') | undefined;
   override?: boolean | undefined;
   additionalLocales?: string[] | undefined;
+  hooks?: string | undefined;
 }): void;
 /**
  * Test if a given directory name (base name only) is an NLS directory.

package/Bundler.js

@@ -209,13 +209,14 @@ let customHooks = {};
  * @param {string} props.rootDir The path to the root message bundle
  * @param {string} props.bundleName The name of the bundle file
  * @param {string} props.locale The locale of the root message bundle
- * @param {string} props.outDir The target directory where the compiled root message
- * @param {string=} props.module The type of module to produce -- 'esm', 'amd', or 'legacy-amd'
- * @param {string=} props.exportType The type of export to produce -- 'default' or 'named'
+ * @param {string} props.outDir The output directory where the built bundle will be written
+ * @param {('amd'|'cjs'|'esm'|'legacy-amd')=} props.module The type of module to produce -- 'amd', 'cjs', 'esm', or 'legacy-amd'.
+ * If not supplied, the Typscript will not be transpiled.
+ * @param {('default'|'named')=} props.exportType The type of export to produce -- 'default' or 'named'
  * @param {boolean=} props.override Indicates the bundle is an override, and only the root
  * locale and those explicitly stated in [--supportedLocales] will be built.
  * @param {string[]=} props.additionalLocales An array of additional locales to build
- * @param {string=} hooks A path to the custom hooks file
+ * @param {string=} props.hooks A path to the custom hooks file
  */
 function build({
   rootDir,

package/l10nBundleBuilder.js

@@ -29,7 +29,7 @@ if ('rootDir' in argsMap && 'bundleName' in argsMap && 'locale' in argsMap && 'o
       --locale\tThe root bundle's locale
       --outDir\tThe output directory where the built bundle will be written
     Optional:
-      --module\tProduce bundles as 'esm', 'amd', or 'legacy-amd' modules
+      --module\tThe type of module to produce -- 'amd', 'cjs', 'esm', or 'legacy-amd'. If not supplied, the Typscript will not be transpiled.
       --exportType\tThe type of export, either 'named' or 'default' (default='default')
       --hooks\tThe hooks file to use (see example)
       --override\tIndicates the bundle is an override, and only the root locale and

package/package.json

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

package/test/{l10nTest.js → l10nTest.ts}

@@ -1,15 +1,17 @@
 'use strict';
-const assert = require('assert');
-const path = require('path');
-const { build, isNlsDir } = require('../Bundler');
-const fsx = require('fs-extra');
-const vm = require('vm');
-const glob = require('glob');
+import assert from 'node:assert';
+import path from 'node:path';
+import { build, isNlsDir } from '../Bundler';
+import fsx from 'fs-extra';
+import vm from 'node:vm';
+import glob from 'glob';
 
 const rootDir = path.join(__dirname, 'resources/nls');
 const outputRoot = path.resolve(__dirname, 'built');
 
-function runTestCases(extractBundle) {
+type ExportType = 'default' | 'named';
+
+function runTestCases(extractBundle: (bundle: string) => any) {
   describe('Bundle files', () => {
     it('creates the root bundle in English', () => {
       const bundle = extractBundle(`app-strings.js`);
@@ -190,27 +192,32 @@ function runTestCases(extractBundle) {
           bundleName: 'app-strings-bad-root.json',
           outDir: path.join(outputRoot, 'nls-bad-metadata')
         });
-      } catch (ex) {
+      } catch (ex: any) {
         didFail = !!ex.message.match(/While processing ro-MD\/app-strings-bad-root.json/);
       }
       assert(didFail === true);
-    })
+    });
 
     it('metadata keys should not be in bundle', () => {
-      assert.strictEqual(Object.keys(bundle).every(k => !k.startsWith('@')), true);
+      assert.strictEqual(
+        Object.keys(bundle).every((k) => !k.startsWith('@')),
+        true
+      );
     });
 
     it('metadata parameters present in locale bundle', () => {
       const birthDate = '2022-09-29 07:25 GMT';
-      assert.equal(bundle.localeParams({
-        total: 1,
-        gender: 'male',
-        title: 'Mr.',
-        birthDate
-      }), 'Moldavian total: 1 unu, gender: male, title: Mr., birthDate: 29.09.2022');
+      assert.equal(
+        bundle.localeParams({
+          total: 1,
+          gender: 'male',
+          title: 'Mr.',
+          birthDate
+        }),
+        'Moldavian total: 1 unu, gender: male, title: Mr., birthDate: 29.09.2022'
+      );
     });
   });
-
 }
 
 describe('Custom hooks', () => {
@@ -258,8 +265,8 @@ describe('Custom hooks', () => {
  * @param {string} outDir
  * @param {string} filePath
  */
-function extractCjsBundle(outDir, filepath) {
-  return require(path.join(outDir, filepath));
+function extractCjsBundle(outDir: string, filePath: string) {
+  return require(path.join(outDir, filePath));
 }
 
 describe('CJS default export', () => {
@@ -281,13 +288,14 @@ describe('AMD', () => {
   /**
    * Read contents of ES6 file and convert to CommonJS export for Node testing
    * @param {string} filepath
+   * @param {ExportType} exportType
    */
-  function extractBundle(filepath, exportType) {
+  function extractBundle(filepath: string, exportType: ExportType) {
     const bundleContents = fsx.readFileSync(filepath).toString();
     // Create a 'define' method in the context which returns the object passed in
     const script = new vm.Script(bundleContents, '');
     const context = vm.createContext({
-      define: function (rb) {
+      define: function (rb: any) {
         // define({ ... })
         if (arguments.length === 1) {
           return rb;
@@ -306,7 +314,11 @@ describe('AMD', () => {
     return rb;
   }
 
-  function testAmd(exportType) {
+  /**
+   *
+   * @param {ExportType} exportType
+   */
+  function testAmd(exportType: ExportType) {
     const outDir = path.resolve(outputRoot, `amd-${exportType}`);
 
     fsx.removeSync(outDir);
@@ -349,10 +361,7 @@ describe('AMD', () => {
     });
 
     it('creates non-standard keys', () => {
-      const bundle = extractBundle(
-        path.join(outDir, 'app-strings-legacy-keys.js'),
-        'named'
-      );
+      const bundle = extractBundle(path.join(outDir, 'app-strings-legacy-keys.js'), 'named');
       expect(bundle['dot.key']()).toEqual('Dot key');
       expect(bundle['.leading.dot.key']()).toEqual('Leading dot key');
       expect(bundle['dash-key']()).toEqual('Dash key');
@@ -377,7 +386,7 @@ describe('Extra locales', () => {
     additionalLocales
   });
 
-  const extractBundle = (fp) => extractCjsBundle(outDir, fp).default;
+  const extractBundle = (fp: string) => extractCjsBundle(outDir, fp).default;
   runTestCases(extractBundle);
 
   it('creates the de bundle in English', () => {
@@ -403,7 +412,7 @@ describe('Extra locales', () => {
 
 describe('Override files', () => {
   const outDir = path.resolve(outputRoot, 'override');
-  const extractBundle = (fp) => extractCjsBundle(outDir, fp).default;
+  const extractBundle = (fp: string) => extractCjsBundle(outDir, fp).default;
 
   describe('with root overrides', () => {
     build({
@@ -430,9 +439,11 @@ describe('Override files', () => {
 
     it('creates the ru-RU override bundle in Russian', () => {
       const bundle = extractBundle(`ru-RU/app-strings-x.js`);
-      assert.equal(Object.keys(bundle).length, 2, "override should have root keys");
+      assert.equal(Object.keys(bundle).length, 2, 'override should have root keys');
       assert.equal(
-        bundle.contentArea({ name: 'Dashboard' }), 'Dashboard ru-RU contentArea override');
+        bundle.contentArea({ name: 'Dashboard' }),
+        'Dashboard ru-RU contentArea override'
+      );
       assert.equal(bundle.pageIntro(), 'root pageIntro');
     });
 
@@ -455,6 +466,7 @@ describe('Override files', () => {
       rootDir,
       bundleName: 'extra-app-strings-x.json',
       override: true,
+      locale: 'en-US',
       additionalLocales: ['zh-Hans'],
       outDir,
       module: 'cjs'
@@ -465,13 +477,14 @@ describe('Override files', () => {
       expect(generatedFiles.length).toEqual(1);
 
       const bundle = extractBundle('zh-Hans/extra-app-strings-x.js');
-      assert.equal(Object.keys(bundle).length, 1, "override should not have root keys");
+      assert.equal(Object.keys(bundle).length, 1, 'override should not have root keys');
       assert.equal(
-        bundle.contentArea({ name: 'Dashboard' }), 'Dashboard zh-Hans contentArea override');
-    })
-  })
-
-})
+        bundle.contentArea({ name: 'Dashboard' }),
+        'Dashboard zh-Hans contentArea override'
+      );
+    });
+  });
+});
 
 describe('extra keys', () => {
   const outDir = path.resolve(outputRoot, 'extra-keys');
@@ -482,11 +495,12 @@ describe('extra keys', () => {
       build({
         rootDir: `${rootDir}-extra-keys`,
         bundleName: 'app-bundle-bad.json',
+        locale: 'en-US',
         outDir
       });
-    } catch (ex) {
+    } catch (ex: any) {
       didFail = ex.message.indexOf('description') >= 0;
     }
     expect(didFail).toBeTruthy();
-  })
-})
+  });
+});

package/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "compilerOptions": {
     "esModuleInterop": true,
+    "target": "ES2021",
+    "module": "esnext",
+    "moduleResolution": "node",
     "strict": true
   },
   "include": [ "**/*.ts" ]