refactor: Convert to ESM

Parse-Dashboard/Authentication.js

@@ -1,9 +1,12 @@
-'use strict';
-var bcrypt = require('bcryptjs');
-var csrf = require('csurf');
-var passport = require('passport');
-var LocalStrategy = require('passport-local').Strategy;
-const OTPAuth = require('otpauth')
+import bcrypt from 'bcryptjs';
+import csrf from 'csurf';
+import passport from 'passport';
+import { Strategy as LocalStrategy } from 'passport-local';
+import OTPAuth from 'otpauth';
+import { randomBytes } from 'node:crypto';
+import connectFlash from 'connect-flash';
+import bodyParser from 'body-parser';
+import cookieSession from 'cookie-session';
 
 /**
  * Constructor for Authentication class
@@ -53,11 +56,11 @@ function initialize(app, options) {
     cb(null, user);
   });
 
-  var cookieSessionSecret = options.cookieSessionSecret || require('crypto').randomBytes(64).toString('hex');
+  var cookieSessionSecret = options.cookieSessionSecret || randomBytes(64).toString('hex');
   const cookieSessionMaxAge = options.cookieSessionMaxAge;
-  app.use(require('connect-flash')());
-  app.use(require('body-parser').urlencoded({ extended: true }));
-  app.use(require('cookie-session')({
+  app.use(connectFlash());
+  app.use(bodyParser.urlencoded({ extended: true }));
+  app.use(cookieSession({
     key    : 'parse_dash',
     secret : cookieSessionSecret,
     maxAge : cookieSessionMaxAge
@@ -150,4 +153,4 @@ function authenticate(userToTest, usernameOnly) {
 Authentication.prototype.initialize = initialize;
 Authentication.prototype.authenticate = authenticate;
 
-module.exports = Authentication;
+export default Authentication;

Parse-Dashboard/CLI/mfa.js

@@ -1,7 +1,9 @@
-const crypto = require('crypto');
-const inquirer = require('inquirer');
-const OTPAuth = require('otpauth');
-const { copy } = require('./utils.js');
+import crypto from 'node:crypto';
+import inquirer from 'inquirer';
+import OTPAuth from 'otpauth';
+import { copy } from './utils.js';
+import QRCode from 'qrcode';
+import bcrypt from 'bcryptjs';
 const phrases = {
   enterPassword: 'Enter a password:',
   enterUsername: 'Enter a username:',
@@ -80,7 +82,6 @@ const generateSecret = ({ app, username, algorithm, digits, period }) => {
   return { config };
 };
 const showQR = text => {
-  const QRCode = require('qrcode');
   QRCode.toString(text, { type: 'terminal' }, (err, url) => {
     console.log(
       '\n------------------------------------------------------------------------------' +
@@ -136,96 +137,94 @@ const showInstructions = ({ app, username, passwordCopied, encrypt, config }) =>
   );
 }
 
-module.exports = {
-  async createUser() {
-    const data = {};
+export async function createUser() {
+  const data = {};
 
-    console.log('');
-    const { username, password } = await inquirer.prompt([
-      {
-        type: 'input',
-        name: 'username',
-        message: phrases.enterUsername
-      },
+  console.log('');
+  const { username, password } = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'username',
+      message: phrases.enterUsername
+    },
+    {
+      type: 'confirm',
+      name: 'password',
+      message: 'Do you want to auto-generate a password?'
+    }
+  ]);
+  data.user = username;
+  if (!password) {
+    const { password } = await inquirer.prompt([
       {
-        type: 'confirm',
+        type: 'password',
         name: 'password',
-        message: 'Do you want to auto-generate a password?'
+        message: phrases.enterPassword
       }
     ]);
-    data.user = username;
-    if (!password) {
-      const { password } = await inquirer.prompt([
-        {
-          type: 'password',
-          name: 'password',
-          message: phrases.enterPassword
-        }
-      ]);
-      data.pass = password;
-    } else {
-      const password = crypto.randomBytes(20).toString('base64');
-      data.pass = password;
+    data.pass = password;
+  } else {
+    const password = crypto.randomBytes(20).toString('base64');
+    data.pass = password;
+  }
+  const { mfa, encrypt } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'encrypt',
+      message: 'Should the password be encrypted? (strongly recommended, otherwise it is stored in clear-text)'
+    },
+    {
+      type: 'confirm',
+      name: 'mfa',
+      message: 'Do you want to enable multi-factor authentication?'
     }
-    const { mfa, encrypt } = await inquirer.prompt([
-      {
-        type: 'confirm',
-        name: 'encrypt',
-        message: 'Should the password be encrypted? (strongly recommended, otherwise it is stored in clear-text)'
-      },
-      {
-        type: 'confirm',
-        name: 'mfa',
-        message: 'Do you want to enable multi-factor authentication?'
-      }
-    ]);
-    if (encrypt) {
-      // Copy the raw password to clipboard
-      copy(data.pass);
+  ]);
+  if (encrypt) {
+    // Copy the raw password to clipboard
+    copy(data.pass);
 
-      // Encrypt password
-      const bcrypt = require('bcryptjs');
-      const salt = bcrypt.genSaltSync(10);
-      data.pass = bcrypt.hashSync(data.pass, salt);
-    }
-    const config = {};
-    if (mfa) {
-      const { app } = await inquirer.prompt([
-        {
-          type: 'input',
-          name: 'app',
-          message: phrases.enterAppName
-        }
-      ]);
-      const { algorithm, digits, period } = await getAlgorithm();
-      const secret  =generateSecret({ app, username, algorithm, digits, period });
-      Object.assign(config, secret.config);
-      showQR(secret.config.url);
-    }
-    config.user = data.user;
-    config.pass = data.pass ;
-    showInstructions({ app: data.app, username, passwordCopied: true, encrypt, config });
-  },
-  async createMFA() {
-    console.log('');
-    const { username, app } = await inquirer.prompt([
-      {
-        type: 'input',
-        name: 'username',
-        message:
-          'Enter the username for which you want to enable multi-factor authentication:'
-      },
+    // Encrypt password
+    const salt = bcrypt.genSaltSync(10);
+    data.pass = bcrypt.hashSync(data.pass, salt);
+  }
+  const config = {};
+  if (mfa) {
+    const { app } = await inquirer.prompt([
       {
         type: 'input',
         name: 'app',
         message: phrases.enterAppName
       }
     ]);
     const { algorithm, digits, period } = await getAlgorithm();
-
-    const { config } = generateSecret({ app, username, algorithm, digits, period });
-    showQR(config.url);
-    // Compose config
-    showInstructions({ app, username, config });
+    const secret  =generateSecret({ app, username, algorithm, digits, period });
+    Object.assign(config, secret.config);
+    showQR(secret.config.url);
   }
-};
+  config.user = data.user;
+  config.pass = data.pass ;
+  showInstructions({ app: data.app, username, passwordCopied: true, encrypt, config });
+}
+
+export async function createMFA() {
+  console.log('');
+  const { username, app } = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'username',
+      message:
+        'Enter the username for which you want to enable multi-factor authentication:'
+    },
+    {
+      type: 'input',
+      name: 'app',
+      message: phrases.enterAppName
+    }
+  ]);
+  const { algorithm, digits, period } = await getAlgorithm();
+
+  const { config } = generateSecret({ app, username, algorithm, digits, period });
+  showQR(config.url);
+  // Compose config
+  showInstructions({ app, username, config });
+}

Parse-Dashboard/CLI/utils.js

@@ -1,7 +1,7 @@
-module.exports = {
-  copy(text) {
-    const proc = require('child_process').spawn('pbcopy');
-    proc.stdin.write(text);
-    proc.stdin.end();
-  }
+import { spawn } from 'node:child_process';
+
+export function copy(text) {
+  const proc = spawn('pbcopy');
+  proc.stdin.write(text);
+  proc.stdin.end();
 }

Parse-Dashboard/CLIHelper.js

@@ -1,6 +1,6 @@
-const { createUser, createMFA } = require('./CLI/mfa');
+import { createUser, createMFA } from './CLI/mfa.js';
 
-module.exports = {
+export default {
   createUser,
-  createMFA
+  createMFA,
 };

Parse-Dashboard/app.js

@@ -1,19 +1,18 @@
-'use strict';
-const express = require('express');
-const path = require('path');
-const packageJson = require('package-json');
-const csrf = require('csurf');
-const Authentication = require('./Authentication.js');
-var fs = require('fs');
-
-const currentVersionFeatures = require('../package.json').parseDashboardFeatures;
-
-var newFeaturesInLatestVersion = [];
+import express from 'express';
+import path from 'node:path';
+import packageJson from 'package-json';
+import csrf from 'csurf';
+import Authentication from './Authentication.js';
+import fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
+
+const { parseDashboardFeatures } = JSON.parse(fs.readFileSync('package.json', 'utf8'));
+let newFeaturesInLatestVersion = [];
 packageJson('parse-dashboard', { version: 'latest', fullMetadata: true })
   .then(latestPackage => {
-    if (latestPackage.parseDashboardFeatures instanceof Array) {
+    if (Array.isArray(latestPackage.parseDashboardFeatures)) {
       newFeaturesInLatestVersion = latestPackage.parseDashboardFeatures.filter(feature => {
-        return currentVersionFeatures.indexOf(feature) === -1;
+        return !parseDashboardFeatures.includes(feature);
       });
     }
   })
@@ -51,9 +50,10 @@ function checkIfIconsExistForApps(apps, iconsFolder) {
   }
 }
 
-module.exports = function(config, options) {
+export default function app(config, options) {
   options = options || {};
   var app = express();
+  const __dirname = path.dirname(fileURLToPath(import.meta.url));
   // Serve public files.
   app.use(express.static(path.join(__dirname,'public')));
 

Parse-Dashboard/index.js

@@ -6,11 +6,10 @@
  * the root directory of this source tree.
  */
 // Command line tool for npm start
-'use strict'
-const CLIHelper = require('./CLIHelper.js');
-const startServer = require('./server');
+import CLIHelper from './CLIHelper.js';
+import startServer from './server.js';
+import { program } from 'commander';
 
-const program = require('commander');
 program.option('--appId [appId]', 'the app Id of the app you would like to manage.');
 program.option('--masterKey [masterKey]', 'the master key of the app you would like to manage.');
 program.option('--serverURL [serverURL]', 'the server url of the app you would like to manage.');

Parse-Dashboard/server.js

@@ -6,13 +6,14 @@
  * the root directory of this source tree.
  */
 // Command line tool for npm start
-'use strict'
-const path = require('path');
-const fs = require('fs');
-const express = require('express');
-const parseDashboard = require('./app');
+import path from 'node:path';
+import fs from 'node:fs';
+import express from 'express';
+import parseDashboard from './app.js';
+import { fileURLToPath } from 'node:url';
+import { createServer } from 'node:https';
 
-module.exports = (options) => {
+export default function server(options) {
   const host = options.host || process.env.HOST || '0.0.0.0';
   const port = options.port || process.env.PORT || 4040;
   const mountPath = options.mountPath || process.env.MOUNT_PATH || '/';
@@ -84,6 +85,7 @@ module.exports = (options) => {
         ];
       }
     } else if (!configServerURL && !configMasterKey && !configAppName) {
+      const __dirname = path.dirname(fileURLToPath(import.meta.url));
       configFile = path.join(__dirname, 'parse-dashboard-config.json');
     }
   } else if (!options.config && process.env.PARSE_DASHBOARD_CONFIG) {
@@ -159,12 +161,12 @@ module.exports = (options) => {
     var privateKey = fs.readFileSync(configSSLKey);
     var certificate = fs.readFileSync(configSSLCert);
 
-    server = require('https').createServer({
+    server = createServer({
       key: privateKey,
       cert: certificate
     }, app).listen(port, host, function () {
       console.log(`The dashboard is now available at https://${server.address().address}:${server.address().port}${mountPath}`);
     });
   }
   handleSIGs(server);
-};
+}