Fix language files for Node+ESM

.config/babel/add-import-extension.js

@@ -0,0 +1,90 @@
+// Based on https://github.com/handsontable/handsontable/blob/bd7628544ff83d6e74a9cc949e2c3c38fef74d76/handsontable/.config/plugin/babel/add-import-extension.js
+
+const { existsSync, lstatSync } = require('fs');
+const { dirname, resolve } = require('path');
+const { types } = require('@babel/core');
+const { declare } = require('@babel/helper-plugin-utils');
+
+const VALID_EXTENSIONS = ['js', 'mjs'];
+
+const hasExtension = moduleName => VALID_EXTENSIONS.some(ext => moduleName.endsWith(`.${ext}`));
+const isCoreJSPolyfill = moduleName => moduleName.startsWith('core-js');
+const isLocalModule = moduleName => moduleName.startsWith('.');
+const isProcessableModule = (moduleName) => {
+    return !hasExtension(moduleName) && (isCoreJSPolyfill(moduleName) || isLocalModule(moduleName));
+};
+
+const createVisitor = ({ declaration, origArgs, extension = 'js' }) => {
+    return (path, { file }) => {
+        const { node: { source, exportKind, importKind } } = path;
+        const { opts: { filename } } = file;
+        const isTypeOnly = exportKind === 'type' || importKind === 'type';
+
+        if (!source || isTypeOnly || !isProcessableModule(source.value)) {
+            return;
+        }
+
+        const { value: moduleName } = source;
+        const absoluteFilePath = resolve(dirname(filename), moduleName);
+        const finalExtension = isCoreJSPolyfill(moduleName) ? 'js' : extension;
+
+        let newModulePath;
+
+        // Resolves a case where "import" points to a module name which exists as a file and
+        // as a directory. For example in this case:
+        // ```
+        // import { registerPlugin } from 'plugins';
+        // ```
+        // and with this directory structure:
+        //   |- editors
+        //   |- plugins
+        //     |- filters/
+        //     |- ...
+        //     +- index.js
+        //   |- plugins.js
+        //   |- ...
+        //   +- index.js
+        //
+        // the plugin will rename import declaration to point to the `plugins.js` file.
+        if (existsSync(`${absoluteFilePath}.js`)) {
+            newModulePath = `${moduleName}.${finalExtension}`;
+
+            // In a case when the file doesn't exist and the module is a directory it will
+            // rename to `plugins/index.js`.
+        } else if (existsSync(absoluteFilePath) && lstatSync(absoluteFilePath).isDirectory()) {
+            newModulePath = `${moduleName}/index.${finalExtension}`;
+
+            // And for other cases it simply put the extension on the end of the module path
+        } else {
+            newModulePath = `${moduleName}.${finalExtension}`;
+        }
+
+        path.replaceWith(declaration(...origArgs(path), types.stringLiteral(newModulePath)));
+    };
+};
+
+module.exports = declare((api, options) => {
+    api.assertVersion(7);
+
+    return {
+        name: 'add-import-extension',
+        visitor: {
+            // It covers default and named imports
+            ImportDeclaration: createVisitor({
+                extension: options.extension,
+                declaration: types.importDeclaration,
+                origArgs: ({ node: { specifiers } }) => [specifiers],
+            }),
+            ExportNamedDeclaration: createVisitor({
+                extension: options.extension,
+                declaration: types.exportNamedDeclaration,
+                origArgs: ({ node: { declaration, specifiers } }) => [declaration, specifiers],
+            }),
+            ExportAllDeclaration: createVisitor({
+                extension: options.extension,
+                declaration: types.exportAllDeclaration,
+                origArgs: () => [],
+            }),
+        }
+    };
+});

CHANGELOG.md

@@ -7,6 +7,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Fixed
+
+- Fix ES module build to make importing language files possible in Node environment. [#1344](https://github.com/handsontable/hyperformula/issues/1344)
+
 ## [2.6.2] - 2024-02-15
 
 ### Changed

babel.config.js

@@ -31,7 +31,9 @@ module.exports = {
     },
     // Environment for transpiling files to be compatible with ES Modules.
     es: {
-      plugins: [],
+      plugins: [
+        ['./.config/babel/add-import-extension.js', { extension: 'mjs' }],
+      ],
     },
   },
 };

package.json

@@ -47,17 +47,18 @@
     "last 2 op_mob versions"
   ],
   "license": "GPL-3.0-only",
-  "module": "es/index.js",
+  "type": "commonjs",
+  "module": "es/index.mjs",
   "main": "commonjs/index.js",
-  "jsnext:main": "es/index.js",
+  "jsnext:main": "es/index.mjs",
   "jsdelivr": "dist/hyperformula.min.js",
   "unpkg": "dist/hyperformula.min.js",
   "typings": "./typings/index.d.ts",
   "scripts": {
     "docs:dev": "npm run typedoc:build-api && vuepress dev docs --silent --no-clear-screen --no-cache",
     "docs:build": "npm run bundle-all && npm run typedoc:build-api && vuepress build docs",
     "bundle-all": "cross-env HF_COMPILE=1 npm-run-all clean compile bundle:** verify-bundles",
-    "bundle:es": "(node script/if-ne-env.js HF_COMPILE=1 || npm run compile) && cross-env-shell BABEL_ENV=es env-cmd -f ht.config.js babel lib --out-dir es",
+    "bundle:es": "(node script/if-ne-env.js HF_COMPILE=1 || npm run compile) && cross-env-shell BABEL_ENV=es env-cmd -f ht.config.js babel lib --out-file-extension .mjs --out-dir es",
     "bundle:cjs": "(node script/if-ne-env.js HF_COMPILE=1 || npm run compile) && cross-env-shell BABEL_ENV=commonjs env-cmd -f ht.config.js babel lib --out-dir commonjs",
     "bundle:development": "(node script/if-ne-env.js HF_COMPILE=1 || npm run compile) && cross-env-shell BABEL_ENV=dist NODE_ENV=development env-cmd -f ht.config.js webpack ./lib/index.js",
     "bundle:production": "(node script/if-ne-env.js HF_COMPILE=1 || npm run compile) && cross-env-shell BABEL_ENV=dist NODE_ENV=production env-cmd -f ht.config.js webpack ./lib/index.js",
@@ -95,6 +96,10 @@
     "check:licenses": "license-checker --production --excludePackages=\"[email protected]\" --onlyAllow=\"MIT; Apache-2.0; BSD-3-Clause; BSD-2-Clause; ISC; BSD; Unlicense\"",
     "tsnode": "ts-node --transpile-only -O {\\\"module\\\":\\\"commonjs\\\"}"
   },
+  "dependencies": {
+    "chevrotain": "^6.5.0",
+    "tiny-emitter": "^2.1.0"
+  },
   "devDependencies": {
     "@babel/cli": "^7.8.4",
     "@babel/core": "^7.8.4",
@@ -154,8 +159,191 @@
     "webpack-cli": "^3.3.11",
     "webpackbar": "^4.0.0"
   },
-  "dependencies": {
-    "chevrotain": "^6.5.0",
-    "tiny-emitter": "^2.1.0"
+  "exports": {
+    ".": {
+      "types": "./typings/index.d.ts",
+      "import": "./es/index.mjs",
+      "require": "./commonjs/index.js"
+    },
+    "./es/i18n/languages": {
+      "types": "./typings/i18n/languages/index.d.ts",
+      "import": "./es/i18n/languages/index.mjs",
+      "require": "./commonjs/i18n/languages/index.js"
+    },
+    "./commonjs/i18n/languages": {
+      "types": "./typings/i18n/languages/index.d.ts",
+      "import": "./es/i18n/languages/index.mjs",
+      "require": "./commonjs/i18n/languages/index.js"
+    },
+    "./es/i18n/languages/csCZ": {
+      "types": "./typings/i18n/languages/csCZ.d.ts",
+      "import": "./es/i18n/languages/csCZ.mjs",
+      "require": "./commonjs/i18n/languages/csCZ.js"
+    },
+    "./commonjs/i18n/languages/csCZ": {
+      "types": "./typings/i18n/languages/csCZ.d.ts",
+      "import": "./es/i18n/languages/csCZ.mjs",
+      "require": "./commonjs/i18n/languages/csCZ.js"
+    },
+    "./es/i18n/languages/daDK": {
+      "types": "./typings/i18n/languages/daDK.d.ts",
+      "import": "./es/i18n/languages/daDK.mjs",
+      "require": "./commonjs/i18n/languages/daDK.js"
+    },
+    "./commonjs/i18n/languages/daDK": {
+      "types": "./typings/i18n/languages/daDK.d.ts",
+      "import": "./es/i18n/languages/daDK.mjs",
+      "require": "./commonjs/i18n/languages/daDK.js"
+    },
+    "./es/i18n/languages/deDE": {
+      "types": "./typings/i18n/languages/deDE.d.ts",
+      "import": "./es/i18n/languages/deDE.mjs",
+      "require": "./commonjs/i18n/languages/deDE.js"
+    },
+    "./commonjs/i18n/languages/deDE": {
+      "types": "./typings/i18n/languages/deDE.d.ts",
+      "import": "./es/i18n/languages/deDE.mjs",
+      "require": "./commonjs/i18n/languages/deDE.js"
+    },
+    "./es/i18n/languages/enGB": {
+      "types": "./typings/i18n/languages/enGB.d.ts",
+      "import": "./es/i18n/languages/enGB.mjs",
+      "require": "./commonjs/i18n/languages/enGB.js"
+    },
+    "./commonjs/i18n/languages/enGB": {
+      "types": "./typings/i18n/languages/enGB.d.ts",
+      "import": "./es/i18n/languages/enGB.mjs",
+      "require": "./commonjs/i18n/languages/enGB.js"
+    },
+    "./es/i18n/languages/enUS": {
+      "types": "./typings/i18n/languages/enUS.d.ts",
+      "import": "./es/i18n/languages/enUS.mjs",
+      "require": "./commonjs/i18n/languages/enUS.js"
+    },
+    "./commonjs/i18n/languages/enUS": {
+      "types": "./typings/i18n/languages/enUS.d.ts",
+      "import": "./es/i18n/languages/enUS.mjs",
+      "require": "./commonjs/i18n/languages/enUS.js"
+    },
+    "./es/i18n/languages/esES": {
+      "types": "./typings/i18n/languages/esES.d.ts",
+      "import": "./es/i18n/languages/esES.mjs",
+      "require": "./commonjs/i18n/languages/esES.js"
+    },
+    "./commonjs/i18n/languages/esES": {
+      "types": "./typings/i18n/languages/esES.d.ts",
+      "import": "./es/i18n/languages/esES.mjs",
+      "require": "./commonjs/i18n/languages/esES.js"
+    },
+    "./es/i18n/languages/fiFI": {
+      "types": "./typings/i18n/languages/fiFI.d.ts",
+      "import": "./es/i18n/languages/fiFI.mjs",
+      "require": "./commonjs/i18n/languages/fiFI.js"
+    },
+    "./commonjs/i18n/languages/fiFI": {
+      "types": "./typings/i18n/languages/fiFI.d.ts",
+      "import": "./es/i18n/languages/fiFI.mjs",
+      "require": "./commonjs/i18n/languages/fiFI.js"
+    },
+    "./es/i18n/languages/frFR": {
+      "types": "./typings/i18n/languages/frFR.d.ts",
+      "import": "./es/i18n/languages/frFR.mjs",
+      "require": "./commonjs/i18n/languages/frFR.js"
+    },
+    "./commonjs/i18n/languages/frFR": {
+      "types": "./typings/i18n/languages/frFR.d.ts",
+      "import": "./es/i18n/languages/frFR.mjs",
+      "require": "./commonjs/i18n/languages/frFR.js"
+    },
+    "./es/i18n/languages/huHU": {
+      "types": "./typings/i18n/languages/huHU.d.ts",
+      "import": "./es/i18n/languages/huHU.mjs",
+      "require": "./commonjs/i18n/languages/huHU.js"
+    },
+    "./commonjs/i18n/languages/huHU": {
+      "types": "./typings/i18n/languages/huHU.d.ts",
+      "import": "./es/i18n/languages/huHU.mjs",
+      "require": "./commonjs/i18n/languages/huHU.js"
+    },
+    "./es/i18n/languages/itIT": {
+      "types": "./typings/i18n/languages/itIT.d.ts",
+      "import": "./es/i18n/languages/itIT.mjs",
+      "require": "./commonjs/i18n/languages/itIT.js"
+    },
+    "./commonjs/i18n/languages/itIT": {
+      "types": "./typings/i18n/languages/itIT.d.ts",
+      "import": "./es/i18n/languages/itIT.mjs",
+      "require": "./commonjs/i18n/languages/itIT.js"
+    },
+    "./es/i18n/languages/nbNO": {
+      "types": "./typings/i18n/languages/nbNO.d.ts",
+      "import": "./es/i18n/languages/nbNO.mjs",
+      "require": "./commonjs/i18n/languages/nbNO.js"
+    },
+    "./commonjs/i18n/languages/nbNO": {
+      "types": "./typings/i18n/languages/nbNO.d.ts",
+      "import": "./es/i18n/languages/nbNO.mjs",
+      "require": "./commonjs/i18n/languages/nbNO.js"
+    },
+    "./es/i18n/languages/nlNL": {
+      "types": "./typings/i18n/languages/nlNL.d.ts",
+      "import": "./es/i18n/languages/nlNL.mjs",
+      "require": "./commonjs/i18n/languages/nlNL.js"
+    },
+    "./commonjs/i18n/languages/nlNL": {
+      "types": "./typings/i18n/languages/nlNL.d.ts",
+      "import": "./es/i18n/languages/nlNL.mjs",
+      "require": "./commonjs/i18n/languages/nlNL.js"
+    },
+    "./es/i18n/languages/plPL": {
+      "types": "./typings/i18n/languages/plPL.d.ts",
+      "import": "./es/i18n/languages/plPL.mjs",
+      "require": "./commonjs/i18n/languages/plPL.js"
+    },
+    "./commonjs/i18n/languages/plPL": {
+      "types": "./typings/i18n/languages/plPL.d.ts",
+      "import": "./es/i18n/languages/plPL.mjs",
+      "require": "./commonjs/i18n/languages/plPL.js"
+    },
+    "./es/i18n/languages/ptPT": {
+      "types": "./typings/i18n/languages/ptPT.d.ts",
+      "import": "./es/i18n/languages/ptPT.mjs",
+      "require": "./commonjs/i18n/languages/ptPT.js"
+    },
+    "./commonjs/i18n/languages/ptPT": {
+      "types": "./typings/i18n/languages/ptPT.d.ts",
+      "import": "./es/i18n/languages/ptPT.mjs",
+      "require": "./commonjs/i18n/languages/ptPT.js"
+    },
+    "./es/i18n/languages/ruRU": {
+      "types": "./typings/i18n/languages/ruRU.d.ts",
+      "import": "./es/i18n/languages/ruRU.mjs",
+      "require": "./commonjs/i18n/languages/ruRU.js"
+    },
+    "./commonjs/i18n/languages/ruRU": {
+      "types": "./typings/i18n/languages/ruRU.d.ts",
+      "import": "./es/i18n/languages/ruRU.mjs",
+      "require": "./commonjs/i18n/languages/ruRU.js"
+    },
+    "./es/i18n/languages/svSE": {
+      "types": "./typings/i18n/languages/svSE.d.ts",
+      "import": "./es/i18n/languages/svSE.mjs",
+      "require": "./commonjs/i18n/languages/svSE.js"
+    },
+    "./commonjs/i18n/languages/svSE": {
+      "types": "./typings/i18n/languages/svSE.d.ts",
+      "import": "./es/i18n/languages/svSE.mjs",
+      "require": "./commonjs/i18n/languages/svSE.js"
+    },
+    "./es/i18n/languages/trTR": {
+      "types": "./typings/i18n/languages/trTR.d.ts",
+      "import": "./es/i18n/languages/trTR.mjs",
+      "require": "./commonjs/i18n/languages/trTR.js"
+    },
+    "./commonjs/i18n/languages/trTR": {
+      "types": "./typings/i18n/languages/trTR.d.ts",
+      "import": "./es/i18n/languages/trTR.mjs",
+      "require": "./commonjs/i18n/languages/trTR.js"
+    }
   }
 }

script/check-publish-package.js

@@ -29,12 +29,12 @@ const FILES_CHECKLIST = [
   'commonjs/index.js',
   'commonjs/HyperFormula.js',
   'dist/hyperformula.js',
-  'es/index.js',
-  'es/HyperFormula.js',
+  'es/index.mjs',
+  'es/HyperFormula.mjs',
   'typings/index.d.ts',
   'typings/HyperFormula.d.ts',
   'dist/languages/plPL.js',
-  'es/i18n/languages/plPL.js',
+  'es/i18n/languages/plPL.mjs',
   'commonjs/i18n/languages/plPL.js',
 ]