@hexonet/semantic-release-whmcs 4.0.3 → 5.0.0

package/lib/delete-marketplace-version.js

@@ -1,40 +1,40 @@
-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) => {
+export default async (pluginConfig, context) => {
   // if (!context.logger) {
   //    context.logger = console;
   // }
 
-  const sep = '+++++++++++++++++++++++++++++++++++++++++++++++++++'
-  const out = `\n${sep}\n${path.basename(__filename)}\n${sep}\n`
+  const sep = "+++++++++++++++++++++++++++++++++++++++++++++++++++";
+  const out = `\n${sep}\n${__filename}\n${sep}\n`;
 
-  const { version } = context
+  const { version } = context;
   if (!version || !version.length) {
-    debug(`${out}Deleting product version failed. No input data available.`)
-    return false
+    debug(`${out}Deleting product version failed. No input data available.`);
+    return false;
   }
 
-  debug(`${out}Delete Version: ${version}`)
+  debug(`${out}Delete Version: ${version}`);
 
-  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, navOpts, gotoOpts, selectorOpts, productid, urlbase } =
-    püppi.config
+  const { page, navOpts, gotoOpts, selectorOpts, productid, urlbase } = püppi.config;
 
   // strip markdown links from notes as not allowed to keep
   try {
     // navigate to product administration
-    const url = `${urlbase}/product/${productid}/edit#versions`
-    await page.goto(url, gotoOpts)
-    debug('product page loaded at %s', url)
+    const url = `${urlbase}/product/${productid}/edit#versions`;
+    await page.goto(url, gotoOpts);
+    debug("product page loaded at %s", url);
     // open versions tab (instead of doing it via url)
     // let selector = '#nav-tabs li a[href="#versions"]';
     // await page.waitForSelector(selector, selectorOpts);
@@ -44,43 +44,43 @@ module.exports = async (pluginConfig, context) => {
     // xpath improvements / changes with v16.1.0
     // -> https://github.com/puppeteer/puppeteer/pull/8730
     // https://github.com/puppeteer/puppeteer/blob/d1681ec06b7c3db4b51c20b17b3339f852efbd4d/test/src/queryhandler.spec.ts
-    let elements = []
+    let elements = [];
     do {
-      const xpath = `xpath/.//td[contains(., "Version ${version}")]/following-sibling::td/a[contains(@class, "btn-styled-red")]`
-      await page.waitForSelector(xpath, selectorOpts)
-      debug('XPath found.')
-      const nav = page.waitForNavigation(navOpts)
-      elements = await page.$$(xpath)
+      const xpath = `xpath/.//td[contains(., "Version ${version}")]/following-sibling::td/a[contains(@class, "btn-styled-red")]`;
+      await page.waitForSelector(xpath, selectorOpts);
+      debug("XPath found.");
+      const nav = page.waitForNavigation(navOpts);
+      elements = await page.$$(xpath);
       if (elements.length) {
-        debug('Delete Button - click.')
-        await elements[0].hover()
-        await elements[0].click()
-        debug('Delete Button - clicked.')
-        await nav
-        debug('Navigation finished.')
+        debug("Delete Button - click.");
+        await elements[0].hover();
+        await elements[0].click();
+        debug("Delete Button - clicked.");
+        await nav;
+        debug("Navigation finished.");
         // confirm deletion
-        const selector = 'button.btn-styled-red'
-        await page.waitForSelector(selector, selectorOpts)
-        debug('deletion confirmation button available')
-        debug('click confirmation button')
-        await page.clickAndNavigate(selector)
-        debug('clicked confirmation button')
-        await nav
-        debug('WHMCS Marketplace deleting product version succeeded.')
+        const selector = "button.btn-styled-red";
+        await page.waitForSelector(selector, selectorOpts);
+        debug("deletion confirmation button available");
+        debug("click confirmation button");
+        await page.clickAndNavigate(selector);
+        debug("clicked confirmation button");
+        await nav;
+        debug("WHMCS Marketplace deleting product version succeeded.");
       }
-    } while (elements.length)
+    } while (elements.length);
   } catch (error) {
     // while loop and having all versions deleted
     if (!/waiting for selector `.\/\//i.test(error.message)) {
-      debug('Deleting product version failed.', error.message)
-      await page.browser().close()
-      return false
+      debug("Deleting product version failed.", error.message);
+      await page.browser().close();
+      return false;
     }
   }
 
-  await page.browser().close()
+  await page.browser().close();
   return {
-    name: 'WHMCS Marketplace Product Version',
-    url: `${urlbase}/product/${productid}`
-  }
-}
+    name: "WHMCS Marketplace Product Version",
+    url: `${urlbase}/product/${productid}`,
+  };
+};

package/lib/get-error.js

@@ -1,7 +1,7 @@
-const SemanticReleaseError = require('@semantic-release/error')
-const ERROR_DEFINITIONS = require('./definitions/errors.js')
+import SemanticReleaseError from "@semantic-release/error";
+import * as ERROR_DEFINITIONS from "./definitions/errors.js";
 
-module.exports = (code) => {
-  const { message, details } = ERROR_DEFINITIONS[code]()
-  return new SemanticReleaseError(message, code, details)
-}
+export default (code) => {
+  const { message, details } = ERROR_DEFINITIONS[code]();
+  return new SemanticReleaseError(message, code, details);
+};

package/lib/get-github-releases.js

@@ -1,6 +1,7 @@
-const debug = require('debug')('semantic-release:whmcs')
-const resolveConfig = require('./resolve-config')
-const GitHub = require('github-api')
+import resolveConfig from "./resolve-config.js";
+import GitHub from "github-api";
+import debugConfig from "debug";
+const debug = debugConfig("semantic-release:whmcs");
 
 // https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting
 // Rate limits to 60 requests/hour per IP for anonymous requests, 5000/hour with authentication
@@ -8,26 +9,24 @@ const GitHub = require('github-api')
 /**
  * A method to get releases from github repository
  */
-module.exports = async (pluginConfig, context) => {
-  debug('Getting releases from GitHub')
+export default async (pluginConfig, context) => {
+  debug("Getting releases from GitHub");
 
-  const { ghrepo, ghtoken } = resolveConfig(context)
+  const { ghrepo, ghtoken } = resolveConfig(context);
 
   const gh = new GitHub({
-    token: ghtoken
-  })
+    token: ghtoken,
+  });
   if (ghrepo) {
     // optional by default false
-    const repo = ghrepo.split('/')
-    const githubReleases = await gh.getRepo(repo[0], repo[1]).listReleases()
+    const repo = ghrepo.split("/");
+    const githubReleases = await gh.getRepo(repo[0], repo[1]).listReleases();
     if (githubReleases.status === 200) {
-      githubReleases.data.forEach((r) =>
-        debug(`Detected GitHub release ${r.name.substring(1)}`)
-      )
-      githubReleases.data.reverse()
-      return githubReleases.data
+      githubReleases.data.forEach((r) => debug(`Detected GitHub release ${r.name.substring(1)}`));
+      githubReleases.data.reverse();
+      return githubReleases.data;
     }
-    debug('Failed to get releases from GitHub')
+    debug("Failed to get releases from GitHub");
   }
-  return false
-}
+  return false;
+};

package/lib/publish.js

@@ -1,22 +1,21 @@
-const debug = require("debug")("semantic-release:whmcs");
-const puppet = require("./puppet");
-const setCompatibleVersions = require("./set-compatible-versions");
-const path = require("path");
+import puppet from "./puppet.js";
+import setCompatibleVersions from "./set-compatible-versions.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) => {
+export default async (pluginConfig, context) => {
   const sep = "+++++++++++++++++++++++++++++++++++++++++++++++++++";
-  const out = `\n${sep}\n${path.basename(__filename)}\n${sep}\n`;
-
+  const out = `\n${sep}\n${__filename}\n${sep}\n`;
   const {
     nextRelease: { notes, version, releaseDate },
   } = context;
   if (!notes || !notes.length || !version || !version.length) {
-    debug(
-      `${out}Publishing new product version failed. No input data available.`
-    );
+    debug(`${out}Publishing new product version failed. No input data available.`);
     return false;
   }
   // strip markdown links from notes as not allowed to keep (taken from remove-markdown and cleaned up)
@@ -76,9 +75,7 @@ module.exports = async (pluginConfig, context) => {
     );
     debug("form input for description finished.");
 
-    await page.clickAndNavigate(
-      'div.listing-edit-container form button[type="submit"]'
-    );
+    await page.clickAndNavigate('div.listing-edit-container form button[type="submit"]');
     await setCompatibleVersions(pluginConfig, context);
   } catch (error) {
     debug("Publishing new product version failed.", error.message);

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;
+};