@hexonet/semantic-release-whmcs 4.0.4 → 5.0.0

package/lib/puppet.js

@@ -1,113 +1,112 @@
-const puppeteer = require('puppeteer')
-const debug = require('debug')('semantic-release:whmcs')
-const resolveConfig = require('./resolve-config')
-
-module.exports = async (context) => {
+import puppeteer from "puppeteer";
+import resolveConfig from "./resolve-config.js";
+import debugConfig from "debug";
+const debug = debugConfig("semantic-release:whmcs");
+export default async (context) => {
+  let config;
   const cfg = {
-    urlbase: 'https://marketplace.whmcs.com',
+    urlbase: "https://marketplace.whmcs.com",
     ...resolveConfig(context),
     // logger: logger,
     gotoOpts: {
-      waitUntil: ['load', 'domcontentloaded'],
-      timeout: 240000
+      waitUntil: ["load", "domcontentloaded"],
+      timeout: 240000,
     },
     navOpts: {
-      waitUntil: ['networkidle0'],
-      timeout: 240000
+      waitUntil: ["networkidle0"],
+      timeout: 240000,
     },
     selectorOpts: {
-      timeout: 10000
+      timeout: 20000,
     },
-    logger: context.logger
-  }
+    logger: context.logger,
+  };
 
   const browser = await puppeteer.launch({
-    headless: cfg.headless === '1',
+    headless: cfg.headless === "1",
     defaultViewport: null, // automatically full-sized
     args: [
-      '--disable-gpu',
-      '--incognito',
-      '--start-maximized',
-      '--no-sandbox',
-      '--disable-setuid-sandbox',
-      '--disable-infobars',
-      '--ignore-certifcate-errors',
-      '--ignore-certifcate-errors-spki-list',
-      '--ignoreHTTPSErrors=true'
-    ]
-  })
-  const { logger } = cfg
-  const [page] = await browser.pages()
+      "--disable-gpu",
+      "--incognito",
+      "--start-maximized",
+      "--no-sandbox",
+      "--disable-setuid-sandbox",
+      "--disable-infobars",
+      "--ignore-certifcate-errors",
+      "--ignore-certifcate-errors-spki-list",
+      "--ignoreHTTPSErrors=true",
+    ],
+  });
+  const { logger } = cfg;
+  const [page] = await browser.pages();
   await page.setExtraHTTPHeaders({
-    'Accept-Language': 'en-GB,en-US;q=0.9,en;q=0.8'
-  })
+    "Accept-Language": "en-GB,en-US;q=0.9,en;q=0.8",
+  });
   await page.setUserAgent(
-    'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36'
-  )
-  await page.setJavaScriptEnabled(true)
+    "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36"
+  );
+  await page.setJavaScriptEnabled(true);
 
   if (cfg.debug) {
-    page.on('console', (msg) => {
+    page.on("console", (msg) => {
       for (let i = 0; i < msg.args().length; i++) {
-        logger.log(`${i}: ${msg.args()[i]}`)
+        logger.log(`${i}: ${msg.args()[i]}`);
       }
-    })
+    });
   }
 
   page.clickAndNavigate = async (selector) => {
-    const { page, navOpts } = this.config
-    const nav = page.waitForNavigation(navOpts)
-    await page.hover(selector)
-    await page.click(selector)
-    await nav
-  }
+    const { page, navOpts } = config;
+    const nav = page.waitForNavigation(navOpts);
+    await page.hover(selector);
+    await page.click(selector);
+    await nav;
+  };
 
   page.enterAndType = async (selector, value) => {
-    const { page, selectorOpts } = this.config
-    await page.waitForSelector(selector, selectorOpts)
-    await page.type(selector, value)
-  }
+    const { page, selectorOpts } = config;
+    await page.waitForSelector(selector, selectorOpts);
+    await page.type(selector, value);
+  };
 
-  this.login = async () => {
-    const { page, login, password, productid, gotoOpts, urlbase } = this.config
-    const selector = 'div.login-leftcol form button[type="submit"]'
+  async function login() {
+    const { page, login, password, productid, gotoOpts, urlbase } = config;
+    const selector = 'div.login-leftcol form button[type="submit"]';
     // do login
     try {
-      await page.goto(`${urlbase}/user/login`, gotoOpts)
-      debug('login form loaded at %s', `${urlbase}/user/login`)
-      await page.enterAndType('#email', login)
-      await page.enterAndType('#password', password)
-      debug('WHMCS Marketplace credentials entered')
-      await page.clickAndNavigate(selector)
-      debug('WHMCS Marketplace login form submitted.')
+      await page.goto(`${urlbase}/user/login`, gotoOpts);
+      debug("login form loaded at %s", `${urlbase}/user/login`);
+      await page.enterAndType("#email", login);
+      await page.enterAndType("#password", password);
+      debug("WHMCS Marketplace credentials entered");
+      await page.clickAndNavigate(selector);
+      debug("WHMCS Marketplace login form submitted.");
     } catch (error) {
-      debug(
-        'WHMCS Marketplace login failed or Product ID missing',
-        error.message
-      )
-      await page.browser().close()
-      return false
+      debug("WHMCS Marketplace login failed or Product ID missing", error.message);
+      await page.browser().close();
+      return false;
     }
-    debug('WHMCS Marketplace login succeeded.')
+
+    debug("WHMCS Marketplace login succeeded.");
 
     // access MP Product ID
-    let tmp = productid
+    let tmp = productid;
     if (!tmp || !/^[0-9]+$/.test(productid) || !parseInt(productid, 10)) {
-      debug('No or invalid WHMCS Marketplace Product ID provided.')
-      await page.browser().close()
-      return false
+      debug("No or invalid WHMCS Marketplace Product ID provided.");
+      await page.browser().close();
+      return false;
     }
 
-    tmp = tmp.replace(/(.)/g, '$&\u200E')
-    debug(`WHMCS Marketplace Product ID: ${tmp}`)
+    tmp = tmp.replace(/(.)/g, "$&\u200E");
+    debug(`WHMCS Marketplace Product ID: ${tmp}`);
 
-    return true
+    return true;
   }
 
-  this.config = {
+  config = {
     ...cfg,
-    page
-  }
+    page,
+  };
 
-  return this
-}
+  return { config, login };
+};

package/lib/resolve-config.js

@@ -1,11 +1,10 @@
-module.exports = ({ env }) => ({
+export default ({ env }) => ({
   login: env.WHMCSMP_LOGIN || false,
   password: env.WHMCSMP_PASSWORD || false,
   productid: env.WHMCSMP_PRODUCTID || false,
-  minversion: env.WHMCSMP_MINVERSION || '7.10',
+  minversion: env.WHMCSMP_MINVERSION || "7.10",
   ghtoken: env.GH_TOKEN || env.GITHUB_TOKEN || false,
   ghrepo: env.GH_REPO || env.GITHUB_REPO || false,
-  headless: env.PUPPETEER_HEADLESS || '1',
-  debug:
-    (env.DEBUG && /^semantic-release:(\*|whmcs)$/.test(env.DEBUG)) || false
-})
+  headless: env.PUPPETEER_HEADLESS || "1",
+  debug: (env.DEBUG && /^semantic-release:(\*|whmcs)$/.test(env.DEBUG)) || false,
+});

package/lib/scrape-marketplace-versions.js

@@ -1,45 +1,47 @@
-const debug = require('debug')('semantic-release:whmcs')
-const puppet = require('./puppet')
-const path = require('path')
+import puppet from "./puppet.js";
+import debugConfig from "debug";
+import { fileURLToPath } from "node:url";
+const __filename = fileURLToPath(import.meta.url);
+const debug = debugConfig("semantic-release:whmcs");
 
 /**
  * A method to publish the module update on whmcs market place
  */
-module.exports = async (pluginConfig, context) => {
-  const sep = '+++++++++++++++++++++++++++++++++++++++++++++++++++'
-  const out = `\n${sep}\n${path.basename(__filename)}\n${sep}\n`
+export default async (pluginConfig, context) => {
+  const sep = "+++++++++++++++++++++++++++++++++++++++++++++++++++";
+  const out = `\n${sep}\n${__filename}\n${sep}\n`;
 
-  const püppi = await puppet(context)
-  const result = await püppi.login()
+  const püppi = await puppet(context);
+  const result = await püppi.login();
   if (!result) {
-    return result
+    return result;
   }
-  const { page, gotoOpts, selectorOpts, productid, urlbase } = püppi.config
+  const { page, gotoOpts, selectorOpts, productid, urlbase } = püppi.config;
 
-  let marketplaceVersions = []
+  let marketplaceVersions = [];
   try {
     // scrap versions from WHMCS marketplace
-    const url = `${urlbase}/product/${productid}/edit#versions`
-    await page.goto(url, gotoOpts)
-    debug(`${out}product page loaded at %s`, url)
-    const selector = 'div#versions tr strong'
-    await page.waitForSelector(selector, selectorOpts)
-    debug('product version table found')
+    const url = `${urlbase}/product/${productid}/edit#versions`;
+    await page.goto(url, gotoOpts);
+    debug(`${out}product page loaded at %s`, url);
+    const selector = "div#versions tr strong";
+    await page.waitForSelector(selector, selectorOpts);
+    debug("product version table found");
     /* istanbul ignore next */
     marketplaceVersions = await page.$$eval(selector, (tds) =>
       tds.map((td) => {
-        return td.innerText.substring(8)
+        return td.innerText.substring(8);
       })
-    )
-    marketplaceVersions.reverse()
-    marketplaceVersions.forEach((v) => debug(`Detected WHMCS version ${v}`))
+    );
+    marketplaceVersions.reverse();
+    marketplaceVersions.forEach((v) => debug(`Detected WHMCS version ${v}`));
   } catch (error) {
-    debug('Publishing new product version failed.', error.message)
-    await page.browser().close()
-    return false
+    debug("Publishing new product version failed.", error.message);
+    await page.browser().close();
+    return false;
   }
 
-  debug('Publishing new product version succeeded.')
-  await page.browser().close()
-  return marketplaceVersions
-}
+  debug("Publishing new product version succeeded.");
+  await page.browser().close();
+  return marketplaceVersions;
+};

package/lib/set-compatible-versions.js

@@ -1,71 +1,72 @@
-const debug = require('debug')('semantic-release:whmcs')
-const puppet = require('./puppet')
-const path = require('path')
+import puppet from "./puppet.js";
+import debugConfig from "debug";
+import { fileURLToPath } from "node:url";
+const debug = debugConfig("semantic-release:whmcs");
+const __filename = fileURLToPath(import.meta.url);
 
 /**
  * A method to publish the module update on whmcs market place
  */
-module.exports = async (pluginConfig, context) => {
-  const sep = '+++++++++++++++++++++++++++++++++++++++++++++++++++'
-  const out = `\n${sep}\n${path.basename(__filename)}\n${sep}\n`
+export default async (pluginConfig, context) => {
+  const sep = "+++++++++++++++++++++++++++++++++++++++++++++++++++";
+  const out = `\n${sep}\n${__filename}\n${sep}\n`;
 
-  const püppi = await puppet(context)
-  const result = await püppi.login()
+  const püppi = await puppet(context);
+  const result = await püppi.login();
   if (!result) {
-    return result
+    return result;
   }
-  const { page, gotoOpts, selectorOpts, productid, urlbase, minversion } =
-    püppi.config
+  const { page, gotoOpts, selectorOpts, productid, urlbase, minversion } = püppi.config;
 
-  debug(out)
+  debug(out);
   try {
     // scrap versions from WHMCS marketplace
-    const url = `${urlbase}/product/${productid}/edit#compatibility`
-    await page.goto(url, gotoOpts)
-    debug('product page loaded at %s', url)
+    const url = `${urlbase}/product/${productid}/edit#compatibility`;
+    await page.goto(url, gotoOpts);
+    debug("product page loaded at %s", url);
 
-    const selector = 'input[name="versionIds[]"]'
-    const submitSelector = 'div#compatibility button[type="submit"]'
-    await page.waitForSelector(selector, selectorOpts)
-    await page.waitForSelector(submitSelector, selectorOpts)
-    debug('compatibility version table found')
+    const selector = 'input[name="versionIds[]"]';
+    const submitSelector = 'div#compatibility button[type="submit"]';
+    await page.waitForSelector(selector, selectorOpts);
+    await page.waitForSelector(submitSelector, selectorOpts);
+    debug("compatibility version table found");
 
-    let tmp = minversion
+    let tmp = minversion;
     if (tmp) {
-      tmp = tmp.replace(/(.)/g, '$&\u200E')
+      tmp = tmp.replace(/(.)/g, "$&\u200E");
     }
-    debug(`Minimum required WHMCS version: ${tmp}`)
+    debug(`Minimum required WHMCS version: ${tmp}`);
     /* istanbul ignore next */
     await page.$$eval(
       selector,
       (checkboxes, minversion) =>
         checkboxes.forEach(function (c) {
-          const checkParts = c.className.split('-')[0].split('_')
-          const minParts = minversion.split('.')
-          let check = true
+          const checkParts = c.className.split("-")[0].split("_");
+          const minParts = minversion.split(".");
+          let check = true;
           for (let i = 0; i < 2; i++) {
-            const a = ~~checkParts[i]
-            const b = ~~minParts[i]
+            const a = ~~checkParts[i];
+            const b = ~~minParts[i];
             if (a > b) {
-              break
+              break;
             }
             if (a < b) {
-              check = false
-              break
+              check = false;
+              break;
             }
           }
-          c.checked = check
+          c.checked = check;
         }),
       minversion
-    )
-    await page.clickAndNavigate(submitSelector)
+    );
+    await page.clickAndNavigate(submitSelector);
   } catch (error) {
-    debug('Updating whmcs compatibility list failed.', error.message)
-    await page.browser().close()
-    return false
+    debug("Updating whmcs compatibility list failed.", error.message);
+    await page.browser().close();
+    return false;
   }
 
-  debug('Updating whmcs compatibility list succeeded.')
-  await page.browser().close()
-  return true
-}
+  debug("Updating whmcs compatibility list succeeded.");
+  await page.browser().close();
+  return true;
+};

package/lib/verify.js

@@ -1,8 +1,8 @@
-const AggregateError = require("aggregate-error");
-const resolveConfig = require("./resolve-config");
-const getError = require("./get-error");
+import AggregateError from "aggregate-error";
+import resolveConfig from "./resolve-config.js";
+import getError from "./get-error.js";
 
-module.exports = async (pluginConfig, context) => {
+export default async (pluginConfig, context) => {
   const cfg = resolveConfig(context);
   const errors = [];
   if (cfg.ghtoken === false) {

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@hexonet/semantic-release-whmcs",
   "description": "`semantic-release` plugin for auto-publishing on WHMCS marketplace",
-  "version": "4.0.4",
+  "version": "5.0.0",
   "private": false,
+  "type": "module",
   "publishConfig": {
     "access": "public"
   },
@@ -10,11 +11,10 @@
     "name": "Kai Schwarz",
     "email": "kschwarz@hexonet.net"
   },
-  "main": "index.js",
   "license": "MIT",
   "engines": {
-    "node": ">=16.15.1",
-    "npm": ">=8.11.0"
+    "node": ">=18",
+    "npm": "8.11.0"
   },
   "homepage": "https://github.com/centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs#readme",
   "repository": "github:centralnicgroup-opensource/rtldev-middleware-semantic-release-whmcs",
@@ -34,9 +34,24 @@
     "semantic-release",
     "version"
   ],
-  "nyc": {
+  "ava": {
+    "files": [
+      "test/**/*.test.js"
+    ],
+    "nodeArguments": [
+      "--no-warnings"
+    ],
+    "timeout": "2m"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "trailingComma": "es5"
+  },
+  "c8": {
     "include": [
-      "lib/**/*.js"
+      "lib/**/*.js",
+      "index.js",
+      "cli.js"
     ],
     "reporter": [
       "json",
@@ -45,39 +60,28 @@
     ],
     "all": true
   },
-  "ava": {
-    "require": [
-      "esm"
-    ]
-  },
+  "main": "index.js",
   "scripts": {
-    "coverage": "nyc npm run test",
-    "test": "ava --fail-fast --verbose --timeout=2m",
-    "lint": "eslint --fix --config=./.eslintrc.js *.js lib/*.js lib/definitions/*.js README.md *.json test/*.test.js"
+    "test": "c8 ava --verbose",
+    "lint": "prettier --check \"*.{js,json}\" \".github/**/*.{md,yml}\" \"{lib,test}/*.js\"",
+    "lint:fix": "prettier --write \"*.{js,json}\" \".github/**/*.{md,yml}\" \"{lib,test}/*.js\""
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/exec": "^6.0.2",
     "@semantic-release/git": "^10.0.1",
-    "ava": "^5.1.0",
-    "eslint": "^8.0.1",
-    "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-json": "^3.0.0",
-    "eslint-plugin-markdown": "^3.0.0",
-    "eslint-plugin-n": "^15.2.2",
-    "eslint-plugin-promise": "^6.0.0",
-    "esm": "^3.2.25",
-    "nyc": "^15.1.0",
-    "semantic-release": "^19.0.3",
+    "ava": "5.1.1",
+    "c8": "^7.12.0",
+    "prettier": "^2.8.3",
+    "semantic-release": "^20.0.2",
     "stream-buffers": "^3.0.2"
   },
   "dependencies": {
     "@semantic-release/error": "^3.0.0",
-    "aggregate-error": "^3.1.0",
+    "aggregate-error": "^4.0.1",
     "debug": "^4.3.4",
     "github-api": "^3.4.0",
-    "puppeteer": "^16.0.0",
-    "yargs": "^17.0.1"
+    "puppeteer": "^19.4.1",
+    "yargs": "^17.5.1"
   }
 }

package/whmcs.js

@@ -1,59 +1,87 @@
-
-const { publish, syncVersions, delVersion, updateCompatibility } = require('./index.js')
+import { createRequire } from "node:module";
+import { publish, syncVersions, delVersion, updateCompatibility } from "./index.js";
+const require = createRequire(import.meta.url);
 
 const context = {
   env: process.env,
-  logger: new class {
-    log (msg) { console.log(msg) }
-    info (msg) { console.log(msg) }
-    error (msg, details) { console.error(msg + ' ' + details) }
-  }()
-}
+  logger: new (class {
+    log(msg) {
+      console.log(msg);
+    }
+    info(msg) {
+      console.log(msg);
+    }
+    error(msg, details) {
+      console.error(msg + " " + details);
+    }
+  })(),
+};
 
 // eslint-disable-next-line no-unused-expressions
-require('yargs')
-  .scriptName('whmcs.js')
-  .usage('$0 <cmd> [args]')
-  .command('publish [ver] [notes]', 'publishes the specified version to the WHMCS Marketplace', (yargs) => {
-    yargs.positional('ver', {
-      type: 'string',
-      demandOption: true,
-      describe: 'the version to publish'
-    }).positional('notes', {
-      type: 'string',
-      demandOption: true,
-      describe: 'the changelog'
-    })
-  }, function (argv) {
-    context.nextRelease = {
-      version: argv.ver,
-      notes: argv.notes
+require("yargs")
+  .scriptName("whmcs.js")
+  .usage("$0 <cmd> [args]")
+  .command(
+    "publish [ver] [notes]",
+    "publishes the specified version to the WHMCS Marketplace",
+    (yargs) => {
+      yargs
+        .positional("ver", {
+          type: "string",
+          demandOption: true,
+          describe: "the version to publish",
+        })
+        .positional("notes", {
+          type: "string",
+          demandOption: true,
+          describe: "the changelog",
+        });
+    },
+    function (argv) {
+      context.nextRelease = {
+        version: argv.ver,
+        notes: argv.notes,
+      };
+      publish({}, context).then((r) => {
+        console.log(r === false ? "Failed" : "Successful");
+      });
+    }
+  )
+  .command(
+    "sync",
+    "adds missing versions to the WHMCS Marketplace",
+    () => {},
+    function () {
+      syncVersions({}, context).then((r) => {
+        console.log(r === false ? "Failed" : "Successful");
+      });
+    }
+  )
+  .command(
+    "del [ver]",
+    "deletes the specified version from the WHMCS Marketplace",
+    (yargs) => {
+      yargs.positional("ver", {
+        type: "string",
+        demandOption: true,
+        describe: "the version to delete",
+      });
+    },
+    function (argv) {
+      context.version = argv.ver;
+      delVersion({}, context).then((r) => {
+        console.log(r === false ? "Failed" : "Successful");
+      });
+    }
+  )
+  .command(
+    "compatibility",
+    "set the compatible WHMCS versions in the Marketplace",
+    () => {},
+    function () {
+      updateCompatibility({}, context).then((r) => {
+        console.log(r === false ? "Failed" : "Successful");
+      });
     }
-    publish({}, context).then(r => {
-      console.log(r === false ? 'Failed' : 'Successful')
-    })
-  })
-  .command('sync', 'adds missing versions to the WHMCS Marketplace', () => {}, function () {
-    syncVersions({}, context).then(r => {
-      console.log(r === false ? 'Failed' : 'Successful')
-    })
-  })
-  .command('del [ver]', 'deletes the specified version from the WHMCS Marketplace', (yargs) => {
-    yargs.positional('ver', {
-      type: 'string',
-      demandOption: true,
-      describe: 'the version to delete'
-    })
-  }, function (argv) {
-    context.version = argv.ver
-    delVersion({}, context).then(r => {
-      console.log(r === false ? 'Failed' : 'Successful')
-    })
-  })
-  .command('compatibility', 'set the compatible WHMCS versions in the Marketplace', () => {}, function () {
-    updateCompatibility({}, context).then(r => {
-      console.log(r === false ? 'Failed' : 'Successful')
-    })
-  })
-  .help()
-  .argv
+  )
+  .help().argv;

package/.eslintignore

@@ -1,3 +0,0 @@
-coverage
-node_modules
-.nyc_output