@adobe/helix-pipeline/src/utils/embed-handler.js

(formerly known as Hypermedia Pipeline)

/*
 * Copyright 2018 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
/**
 * Handles `embed` MDAST nodes by converting them into `<esi:include>` tags
 * @param {string} EMBED_SERVICE the URL of an embedding service compatible with https://github.com/adobe/helix-embed that returns HTML
 */
const URI = require('uri-js');

function embed({ EMBED_SERVICE } = {}) {
  return function handler(h, node, _, handlechild) {
    const { url } = node;
    let src = url;
    if (URI.parse(url).reference === 'absolute') {
      src = URI.normalize([EMBED_SERVICE, EMBED_SERVICE.slice(-1) !== '/' ? '/' : '', url].join(''));
    }
    const props = {
      // prepend the embed service for absolute URLs
      src,
    };
    const retval = [h(node, 'esi:include', props)];

    if (node.children && node.children.length) {
      const rem = h(node, 'esi:remove', {});
      node.children.forEach((childnode) => handlechild(h, childnode, node, rem));
      retval.push(rem);
    }

    return retval;
  };
}

module.exports = embed;