html-snapshots 5.11.0 → 6.1.0

package/eslint.config.js

@@ -1,23 +0,0 @@
-const js = require('@eslint/js');
-const globals = require('globals');
-
-module.exports = [{
-  ignores: [
-    'tmp/**',
-    'coverage/**',
-    'examples/**',
-    'test/mocha/html-snapshots/server/**'
-  ]
-}, {
-  languageOptions: {
-    sourceType: 'commonjs',
-    globals: {
-      ...globals.node
-    }
-  },
-  files: ["**/*.js"],
-  rules: {
-    ...js.configs.recommended.rules,
-    "no-console": 0
-  }
-}];

package/lib/phantom/customFilter.js

@@ -1,24 +0,0 @@
-/*
- * customFilter.js
- *
- * Produce a single snapshot for a web page.
- * Snapshot taken when selector is(:visible).
- * Applies a custom filter to the snapshot output.
- *
- * This is a phantomJS script that runs in phantomjs.
- *
- * Copyright (c) 2013 - 2025 Alex Grant, LocalNerve, contributors
- * Licensed under the MIT license.
- */
-var selectorDetect = require("./modules/selectorDetect");
-var cli = require("./modules/cli");
-var detectors = require("./modules/detectors");
-
-var options = cli.selector();
-var customFilter = require(options.module);
-
-selectorDetect(
-  options,
-  options.useJQuery ? detectors.jquerySelector : detectors.querySelector,
-  customFilter
-);

package/lib/phantom/default.js

@@ -1,21 +0,0 @@
-/*
- * default.js
- *
- * Produce a single snapshot for a web page.
- * Snapshot taken when a selector is detected visible.
- *
- * This is a phantomJS script that runs in phantomjs.
- *
- * Copyright (c) 2013 - 2025 Alex Grant, LocalNerve, contributors
- * Licensed under the MIT license.
- */
-var selectorDetect = require("./modules/selectorDetect");
-var cli = require("./modules/cli");
-var detectors = require("./modules/detectors");
-
-var options = cli.selector();
-
-selectorDetect(
-  options,
-  options.useJQuery ? detectors.jquerySelector : detectors.querySelector
-);

package/lib/phantom/modules/cli.js

@@ -1,100 +0,0 @@
-/*
- * cli.js
- *
- * Handles phantomjs command line interface.
- * Reads the command line arguments and returns options.
- *
- * This is a module for a phantomJS script that runs in phantomjs.
- *
- * Copyright (c) 2013 - 2025 Alex Grant, LocalNerve, contributors
- * Licensed under the MIT license.
- */
-
-var system = require("system");
-var globals = require("./globals");
-
-module.exports = {
-
-  /**
-   * command line argument handling for selector based snapshot scripts
-   *  args: PHANTOM_SCRIPT OUTPUTFILE URL SELECTOR [TIMEOUT INTERVAL USEJQUERY FILTER]
-   */
-  selector: function () {
-
-    var options = {};
-    var defaults = {
-
-      // outputFile (required)
-      // The file to write the snapshot to
-      // encoding is the same as served from url
-      outputFile: "snapshot.html",
-
-      // url (required)
-      // The url to produce the snapshot from
-      url: "http://localhost/",
-
-      // selector (required)
-      // The selector to wait for before taking the snapshot
-      // When the selector is visible, this defines document readiness
-      selector: "body",
-
-      // timeout (optional)
-      // The maximum amount of time (ms) to wait before giving up on the snapshot
-      timeout: 10000,
-
-      // checkInterval (optional)
-      // The frequency (ms) to check for document readiness
-      checkInterval: 250,
-
-      // useJQuery (optional)
-      // flag to indicate use jQuery selector or not. jQuery must already exist in page.
-      useJQuery: false,
-
-      // verbose (optional)
-      // flag to indicate verbose output is desired.
-      verbose: false
-
-      // module (optional)
-      // An external module to load
-      // (default undefined)
-    };
-
-    if (system.args.length < 4) {
-      globals.exit(3, "phantomjs script '"+system.args[0]+"' expected these arguments: OUTPUTFILE URL SELECTOR [TIMEOUT INTERVAL JQUERY MODULE]");
-    } else {
-
-      options.outputFile = system.args[1];
-      options.url = system.args[2];
-      options.selector = system.args[3];
-      if (system.args[4]) {
-        options.timeout = parseInt(system.args[4], 10);
-      }
-      if (system.args[5]) {
-        options.checkInterval = parseInt(system.args[5], 10);
-      }
-      if (system.args[6]) {
-        var useJQuery = system.args[6].toLowerCase();
-        options.useJQuery =
-          (useJQuery === "true" || useJQuery === "yes" || useJQuery === "1");
-      }
-      if (system.args[7]) {
-        var verbose = system.args[7].toLowerCase();
-        options.verbose =
-          (verbose === "true" || verbose === "yes" || verbose === "1");
-      }
-      if (system.args[8] && system.args[8] !== "undefined") {
-        options.module = system.args[8];
-      }
-
-      // ensure defaults, replaces false with false in two cases (useJQuery, verbose)
-      Object.keys(defaults).forEach(function(prop) {
-        if (!options[prop]) {
-          options[prop] = defaults[prop];
-        }
-      });
-    }
-
-    return options;
-
-  }
-};

package/lib/phantom/modules/detectors.js

@@ -1,48 +0,0 @@
-/*
- * detectors.js
- *
- * A collection of detector functions that detect when a page is ready for a snapshot.
- *
- * The detector functions are run in PhantomJS page.evaluate in the context of a webpage,
- * in a sandboxed execution context.
- * Other special rules apply: http://phantomjs.org/api/webpage/method/evaluate.html
- *
- * The detector functions return true when the page is ready, false if not.
- *
- * This is a module for a phantomJS script that runs in phantomjs.
- *
- * Copyright (c) 2013 - 2025 Alex Grant, LocalNerve, contributors
- * Licensed under the MIT license.
- */
-/* global document, $ */
-module.exports = {
-
-  // Use plain Web API detection, with standard selectors
-  // https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Getting_Started/Selectors
-  // Returns true on element visibility
-  querySelector: function(options) {
-    var result = false;
-    var el = document.querySelector(options.selector);
-
-    if (el) {
-      // el must be an HTMLElement that is visible
-      result = el.offsetWidth && el.offsetHeight;
-    }
-
-    return result;
-  },
-
-  // Use JQuery selectors
-  // Returns true on element visibility
-  jquerySelector: function(options) {
-    var result = false;
-
-    if (typeof $ !== "undefined") {
-      // the definition of document readiness is visibility
-      result = $(options.selector).is(":visible");
-    }
-
-    return result;
-  }
-
-};

package/lib/phantom/modules/globals.js

@@ -1,43 +0,0 @@
-/*
- * globals.js
- *
- * Globals and module utilities.
- *
- * This is a module for a phantomJS script that runs in phantomjs.
- *
- * Copyright (c) 2013 - 2025 Alex Grant, LocalNerve, contributors
- * Licensed under the MIT license.
- */
-/* global phantom */
-/**
- * Exit phantomJS
- */
-function _exit(code, msg) {
-  if (code !== 0) {
-    console.error(msg);
-  } else {
-    console.log(msg);
-  }
-  phantom.exit(code);
-}
-
-/**
- * Global error handler
- */
-phantom.onError = function(msg, trace) {
-  var msgStack = ["PhantomJS error: " + msg];
-  if (trace && trace.length) {
-    msgStack.push("Trace:");
-    trace.forEach(function(t) {
-      msgStack.push(" -> " + (t.file || t.sourceURL) + ": " + t.line + (t.function ? " (in function " + t.function +")" : ""));
-    });
-  }
-  // Don't call _exit from here, causes strange crash w/linux rebuilt binary.
-  // https://github.com/ariya/phantomjs/issues/14132
-  console.log(msgStack.join("\n"));
-  phantom.exit(-1);
-};
-
-module.exports = {
-  exit: _exit
-};

package/lib/phantom/modules/selectorDetect.js

@@ -1,108 +0,0 @@
-/*
- * selectorDetect.js
- *
- * Produce a single snapshot for a web page when a given selector is detected.
- *
- * This is a module for a phantomJS script that runs in phantomjs.
- *
- * Copyright (c) 2013 - 2025 Alex Grant, LocalNerve, contributors
- * Licensed under the MIT license.
- */
-
-// Get the start time immediately since we're already in a PhantomJS process instance
-// The spawner is already counting down (with allowances)...
-var start = new Date().getTime();
-
-/**
- * Dependencies, phantomjs
- */
-var page = require("webpage").create();
-var fs = require("fs");
-var globals = require("./globals");
-var verbose = require("./verbose");
-
-/**
- * waitFor
- *
- * Heavily borrowed from phantomJS 'waitFor' example
- */
-function waitFor (testFx, onReady, onTimeout, timeout, checkInterval) {
-  var condition = false,
-  interval = setInterval(function () {
-    if ( (new Date().getTime() - start < timeout) && !condition ) {
-      // If not timeout yet and condition not yet fulfilled
-      condition = testFx();
-    } else {
-      clearInterval(interval); // Stop this interval
-      if ( !condition ) {
-        // If condition still not fulfilled (timeout but condition is 'false')
-        onTimeout();
-      } else {
-        // Condition fulfilled (timeout and/or condition is 'true')
-        onReady((new Date().getTime() - start));
-      }
-    }
-  }, checkInterval);
-}
-
-/**
- * snapshot
- *
- * Opens the page and waits for the selector to become visible. Then takes the html snapshot.
- * Applies an optional output filter to the html content.
- *
- */
-function snapshot (options, detector, filter) {
-  filter = filter || function(content) { return content; };
-
-  console.log("Creating snapshot for "+options.url+"...");
-
-  // https://github.com/ariya/phantomjs/issues/10930
-  page.customHeaders = {
-    "Accept-Encoding": "identity"
-  };
-
-  // add optional verbose output
-  if (options.verbose) {
-    verbose(page);
-  }
-
-  // create the snapshot
-  page.open(options.url, {
-    resourceTimeout: options.timeout - 300 // a little space to report problems.
-  }, function (status) {
-    if (status !== "success") {
-      // if phantomJS could not load the page, so end right now
-      globals.exit(2, "Unable to load page " + options.url);
-    } else {
-      // phantomJS loaded the page, so wait for it to be ready
-      waitFor(
-
-        // The test to determine readiness
-        function () {
-          return page.evaluate(detector, {
-            selector: options.selector,
-            url: options.url
-          });
-        },
-
-        // The onReady callback
-        function (time) {
-          fs.write(options.outputFile, filter(page.content), "w");
-          globals.exit(0, "snapshot for "+options.url+" finished in "+time+" ms\n  written to "+options.outputFile);
-        },
-
-        // The onTimeout callback
-        function () {
-          globals.exit(1, "timed out waiting for "+options.selector+" to become visible for "+options.url);
-        },
-
-        options.timeout,
-        options.checkInterval
-
-      );
-    }
-  });
-}
-
-module.exports = snapshot;

package/lib/phantom/modules/verbose.js

@@ -1,71 +0,0 @@
-/*
- * verbose.js
- *
- * Adds handlers to WebPage module to produce additional output for debugging.
- *
- * This is a module for a phantomJS script that runs in phantomjs.
- *
- * Copyright (c) 2013 - 2025 Alex Grant, LocalNerve, contributors
- * Licensed under the MIT license.
- */
-/* global window */
-var system = require("system");
-
-/**
- * Decorate the given WebPage with handlers to produce verbose output.
- * Source:
- * https://newspaint.wordpress.com/2013/04/25/getting-to-the-bottom-of-why-a-phantomjs-page-load-fails/
- */
-function verbose (page) {
-
-  page.onResourceError = function(resourceError) {
-      system.stderr.writeLine('= onResourceError()');
-      system.stderr.writeLine('  - unable to load url: "' + resourceError.url + '"');
-      system.stderr.writeLine('  - error code: ' + resourceError.errorCode + ', description: ' + resourceError.errorString );
-  };
-
-  page.onError = function(msg, trace) {
-      system.stderr.writeLine('= onError()');
-      var msgStack = ['  ERROR: ' + msg];
-      if (trace) {
-          msgStack.push('  TRACE:');
-          trace.forEach(function(t) {
-              msgStack.push('    -> ' + t.file + ': ' + t.line + (t.function ? ' (in function "' + t.function + '")' : ''));
-          });
-      }
-      system.stderr.writeLine(msgStack.join('\n'));
-  };
-
-  page.onResourceRequested = function (request) {
-      system.stderr.writeLine('= onResourceRequested()');
-      system.stderr.writeLine('  request: ' + JSON.stringify(request, undefined, 4));
-  };
-
-  page.onResourceReceived = function(response) {
-      system.stderr.writeLine('= onResourceReceived()' );
-      system.stderr.writeLine('  id: ' + response.id + ', stage: "' + response.stage + '", response: ' + JSON.stringify(response));
-  };
-
-  page.onLoadStarted = function() {
-      system.stderr.writeLine('= onLoadStarted()');
-      var currentUrl = page.evaluate(function() {
-          return window.location.href;
-      });
-      system.stderr.writeLine('  leaving url: ' + currentUrl);
-  };
-
-  page.onNavigationRequested = function(url, type, willNavigate, main) {
-      system.stderr.writeLine('= onNavigationRequested');
-      system.stderr.writeLine('  destination_url: ' + url);
-      system.stderr.writeLine('  type (cause): ' + type);
-      system.stderr.writeLine('  will navigate: ' + willNavigate);
-      system.stderr.writeLine('  from page\'s main frame: ' + main);
-  };
-
-  page.onLoadFinished = function(status) {
-      system.stderr.writeLine('= onLoadFinished()');
-      system.stderr.writeLine('  status: ' + status);
-  };
-}
-
-module.exports = verbose;

package/lib/phantom/removeScripts.js

@@ -1,30 +0,0 @@
-/*
- * removeScripts.js
- *
- * Produce a single snapshot for a web page.
- * Snapshot taken when selector is(:visible).
- * Applies a single filter to remove any script tags.
- *
- * This is a phantomJS script that runs in phantomjs.
- *
- * Copyright (c) 2013 - 2025 Alex Grant, LocalNerve, contributors
- * Licensed under the MIT license.
- */
-var selectorDetect = require("./modules/selectorDetect");
-var cli = require("./modules/cli");
-var detectors = require("./modules/detectors");
-
-/**
- * Remove all script tags from content
- */
-function removeScriptTags(content) {
-  return content.replace(/<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi, "");
-}
-
-var options = cli.selector();
-
-selectorDetect(
-  options,
-  options.useJQuery ? detectors.jquerySelector : detectors.querySelector,
-  removeScriptTags
-);