ESM package (#241)

Author: Corentin Mors

package.json

@@ -2,10 +2,10 @@
     "name": "@dashlane/cli",
     "version": "6.2416.0",
     "description": "Manage your Dashlane vault through a CLI tool",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
+    "type": "module",
+    "main": "dist/index.cjs",
     "bin": {
-        "dcli": "dist/index.js"
+        "dcli": "dist/index.cjs"
     },
     "pkg": {
         "assets": [
@@ -22,7 +22,7 @@
         "watch": "tsc --watch",
         "lint": "eslint src",
         "format": "prettier --write src && eslint --fix src",
-        "start": "node dist",
+        "start": "node dist/index.cjs",
         "pkg:linux": "pkg . -t node18-linux-x64 -o bundle/dcli-linux -C GZip --public --public-packages tslib,thirty-two --no-bytecode",
         "pkg:macos": "pkg . -t node18-macos-x64 -o bundle/dcli-macos -C GZip --public --public-packages tslib,thirty-two --no-bytecode",
         "pkg:macos-arm": "pkg . -t node18-macos-arm64 -o bundle/dcli-macos-arm -C GZip --public --public-packages tslib,thirty-two --no-bytecode",
@@ -59,7 +59,7 @@
         "@typescript-eslint/eslint-plugin": "^7.8.0",
         "@typescript-eslint/parser": "^7.8.0",
         "@yao-pkg/pkg": "^5.11.5",
-        "chai": "^4.4.1",
+        "chai": "^5.1.1",
         "esbuild": "^0.21.2",
         "eslint": "^8.57.0",
         "eslint-config-prettier": "^9.1.0",
@@ -78,8 +78,8 @@
         "@node-rs/argon2": "^1.8.3",
         "better-sqlite3": "^10.0.0",
         "commander": "^12.0.0",
-        "got": "^11.8.6",
-        "inquirer": "^9.2.20",
+        "got": "^14.2.1",
+        "inquirer": "^9.2.21",
         "inquirer-search-list": "^1.2.6",
         "jsonpath-plus": "^9.0.0",
         "node-mac-auth": "^1.0.0",

scripts/build.js

@@ -1,14 +1,17 @@
 #!/usr/bin/env node
 
-const os = require('os');
-const fs = require('fs');
-const path = require('path');
-const process = require('process');
-const childProcess = require('child_process');
-const esbuild = require('esbuild');
-const packageJSON = require('../package.json');
+import os from 'os';
+import fs from 'fs';
+import path, { format } from 'path';
+import process from 'process';
+import childProcess from 'child_process';
+import esbuild from 'esbuild';
+import packageJSON from '../package.json' assert { type: 'json' };
+import { fileURLToPath } from 'url';
 
 const platform = os.platform();
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 /* eslint-disable no-console */
 async function main(argv = process.argv) {
@@ -63,14 +66,15 @@ async function main(argv = process.argv) {
         sourceRoot: buildPath,
         bundle: true,
         platform: 'node',
-        outdir: distPath,
+        format: 'cjs',
         external: externalDependencies,
         treeShaking: true,
         // External source map for debugging
         sourcemap: true,
         // Minify and keep the original names
         minify: true,
         keepNames: true,
+        outfile: path.join(distPath, 'index.cjs')
     };
     console.error('Running esbuild:');
     console.error(esbuildOptions);

src/command-handlers/configure.ts

@@ -72,8 +72,9 @@ export const configureUserPresenceVerification = async (options: {
 
     if (method === 'biometrics') {
         if (process.platform === 'darwin') {
-            const { canPromptTouchID } = await import('node-mac-auth');
-            if (!canPromptTouchID()) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-var-requires
+            const nodemacauth = require('node-mac-auth') as typeof import('node-mac-auth');
+            if (!nodemacauth.canPromptTouchID()) {
                 throw new Error('Biometrics are not supported on your device.');
             }
         }

src/modules/auth/userPresenceVerification.ts

@@ -13,7 +13,9 @@ export const userPresenceVerification = async (params: { deviceConfiguration: De
 
     if (deviceConfiguration.userPresenceVerification === 'biometrics') {
         if (process.platform === 'darwin') {
-            const { canPromptTouchID, promptTouchID } = await import('node-mac-auth');
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-var-requires
+            const nodemacauth = require('node-mac-auth') as typeof import('node-mac-auth');
+            const { canPromptTouchID, promptTouchID } = nodemacauth;
             if (canPromptTouchID()) {
                 return promptTouchID({
                     reason: 'validate your identity before accessing your vault',

src/modules/crypto/decrypt.ts

@@ -1,12 +1,12 @@
 import * as argon2 from '@node-rs/argon2';
 import winston from 'winston';
 import * as xmlJs from 'xml-js';
-import * as crypto from 'crypto';
+import crypto from 'crypto';
 import { promisify } from 'util';
 import zlib from 'zlib';
 import { CipherData, EncryptedData } from './types';
-import { hmacSha256, sha512 } from './hash';
-import { deserializeEncryptedData } from './encryptedDataDeserialization';
+import { hmacSha256, sha512 } from './hash.js';
+import { deserializeEncryptedData } from './encryptedDataDeserialization.js';
 import { BackupEditTransaction, LocalConfiguration, SymmetricKeyGetter } from '../../types';
 
 interface DecryptAesCbcHmac256Params {

src/modules/crypto/encrypt.ts

@@ -1,6 +1,6 @@
-import * as crypto from 'crypto';
-import { serializeEncryptedData } from './encryptedDataSerialization';
-import { hmacSha256, sha512 } from './hash';
+import crypto from 'crypto';
+import { serializeEncryptedData } from './encryptedDataSerialization.js';
+import { hmacSha256, sha512 } from './hash.js';
 import { EncryptedData } from './types';
 
 export const encryptAesCbcHmac256 = (originalKey: Buffer, content: Buffer): string => {

src/modules/crypto/test.ts

@@ -1,8 +1,8 @@
 import { assert } from 'chai';
-import * as crypto from 'crypto';
-import { decrypt } from './decrypt';
-import { encryptAesCbcHmac256 } from './encrypt';
-import { deserializeEncryptedData } from './encryptedDataDeserialization';
+import crypto from 'crypto';
+import { decrypt } from './decrypt.js';
+import { encryptAesCbcHmac256 } from './encrypt.js';
+import { deserializeEncryptedData } from './encryptedDataDeserialization.js';
 
 describe('Encrypt and decrypt using random symmetric key', () => {
     it('ciphering params parsed after encryption are correct', () => {

src/utils/strings.ts

@@ -1,4 +1,4 @@
-import commander from 'commander';
+import * as commander from 'commander';
 import { Parser } from '@json2csv/plainjs';
 import { flatten } from '@json2csv/transforms';
 

tsconfig.json

@@ -24,9 +24,9 @@
         // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
 
         /* Modules */
-        "module": "commonjs" /* Specify what module code is generated. */,
+        "module": "ES2022" /* Specify what module code is generated. */,
         "rootDir": "src" /* Specify the root folder within your source files. */,
-        "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
+        "moduleResolution": "Bundler" /* Specify how TypeScript looks up a file from a given module specifier. */,
         // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
         // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
         // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */