feat(pipe): Remove image responsifier (#381)

fixes #380

Author: tripodsan

docs/secrets.schema.json

@@ -132,23 +132,17 @@ export interface Secrets {
    * Timeout for outgoing HTTP requests in milliseconds
    */
   HTTP_TIMEOUT?: number;
-  /**
-   * Maximum physical with of responsive images to generate
-   */
-  IMAGES_MAX_SIZE?: number;
-  /**
-   * Number of intermediary size steps to create per image
-   */
-  IMAGES_SIZE_STEPS?: number;
-  /**
-   * Value for the `sizes` attribute of generated responsive images
-   */
-  IMAGES_SIZES?: string;
   TEST_BOOLEAN?: boolean;
   /**
    * Print XML with line breaks and indentation
    */
   XML_PRETTY?: boolean;
+  /**
+   * Sanitize the HTML output to guard against XSS attacks.
+   *
+   * **Note:** this flag applies a pretty aggressive DOM filtering that will strip out a lot of HTML that your authors might find useful. The setting is meant for processing truly untrusted inputs, such as comments in a social media site.
+   */
+  SANITIZE_DOM?: boolean;
   /**
    * This interface was referenced by `Secrets`'s JSON-Schema definition
    * via the `patternProperty` "[A-Z0-9_]+".

docs/secrets.schema.md

@@ -16,7 +16,6 @@ const fetch = require('../html/fetch-markdown.js');
 const parse = require('../html/parse-markdown.js');
 const meta = require('../html/get-metadata.js');
 const html = require('../html/make-html.js');
-// const responsive = require('../html/responsify-images.js');
 const type = require('../utils/set-content-type.js');
 const selectStatus = require('../html/set-status.js');
 const smartypants = require('../html/smartypants');
@@ -69,9 +68,6 @@ const htmlpipe = (cont, context, action) => {
     .before(selectstrain)
     .before(selecttest)
     .before(html).expose('html')
-    // todo: responsive used to operate on the htast, therefore ignored if content.document was used
-    // todo: there is similar logic in the image-handler during jsdom creation....
-    // .before(responsive)
     .before(sanitize).when(paranoid)
     .once(cont)
     .after(type('text/html'))

package-lock.json

@@ -60,21 +60,6 @@
       "description": "Timeout for outgoing HTTP requests in milliseconds",
       "default": 1000
     },
-    "IMAGES_MAX_SIZE": {
-      "type": "integer",
-      "description": "Maximum physical with of responsive images to generate",
-      "default": 4096
-    },
-    "IMAGES_SIZE_STEPS": {
-      "type": "integer",
-      "description": "Number of intermediary size steps to create per image",
-      "default": 4
-    },
-    "IMAGES_SIZES": {
-      "type": "string",
-      "description": "Value for the `sizes` attribute of generated responsive images",
-      "default": "100vw"
-    },
     "TEST_BOOLEAN": {
       "type":"boolean",
       "default": true

src/action.d.ts

@@ -17,7 +17,6 @@ const mdast2hast = require('mdast-util-to-hast');
 const { JSDOM } = require('jsdom');
 const toDOM = require('./hast-util-to-dom');
 const HeadingHandler = require('./heading-handler');
-const image = require('./image-handler');
 const embed = require('./embed-handler');
 const link = require('./link-handler');
 const types = require('../schemas/mdast.schema.json').properties.type.enum;
@@ -39,10 +38,6 @@ class VDOMTransformer {
    * Initializes the transformer with a Markdown document or fragment of a document
    * @param {Node} mdast the markdown AST node to start the transformation from.
    * @param {object} options options for custom transformers
-   * @param {string[]} options.IMAGES_SIZES a list of size media queries
-   * @param {number} options.IMAGES_MIN_SIZE from smallest possible size
-   * @param {number} options.IMAGES_MAX_SIZE to largest possible size
-   * @param {number} options.IMAGES_SIZE_STEPS steps number of steps
    */
   constructor(mdast, options) {
     this._matchers = [];
@@ -59,7 +54,6 @@ class VDOMTransformer {
 
     this._headingHandler = new HeadingHandler(options);
     this.match('heading', this._headingHandler.handler());
-    this.match('image', image(options));
     this.match('embed', embed(options));
     this.match('link', link(options));
     this.match('html', (h, node) => {

src/defaults/html.pipe.js

@@ -35,14 +35,6 @@ describe('Test Coercing Secrets', () => {
     assert.equal(action.secrets.REPO_RAW_ROOT, 'https://raw.githubusercontent.com/');
   });
 
-  it('Defaults have correct types (number)', async () => {
-    const action = { logger };
-    await coerce(action);
-    assert.ok(action.secrets.IMAGES_MAX_SIZE);
-    assert.equal(action.secrets.IMAGES_MAX_SIZE, 4096);
-    assert.equal(typeof action.secrets.IMAGES_MAX_SIZE, 'number');
-  });
-
   it('Defaults have correct types (boolean)', async () => {
     const action = { logger };
     await coerce(action);
@@ -55,11 +47,4 @@ describe('Test Coercing Secrets', () => {
     assert.equal(action.secrets.TEST_BOOLEAN, false);
     assert.equal(typeof action.secrets.TEST_BOOLEAN, 'boolean');
   });
-
-  it('Secrets have correct types (number)', async () => {
-    const action = { logger, secrets: { IMAGES_MAX_SIZE: '4000' } };
-    await coerce(action);
-    assert.equal(action.secrets.IMAGES_MAX_SIZE, 4000);
-    assert.equal(typeof action.secrets.IMAGES_MAX_SIZE, 'number');
-  });
 });