@canopycanopycanopy/b-ber-lib 2.0.0 → 3.0.2

package/utils/index.js

@@ -1,71 +1,45 @@
 "use strict";
 
 var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
-
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
-
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-
 exports.createUnsupportedInline = createUnsupportedInline;
 exports.ensure = void 0;
 exports.ensurePoster = ensurePoster;
 exports.ensureSource = ensureSource;
 exports.ensureSupportedClassNames = ensureSupportedClassNames;
-exports.validatePosterImage = exports.safeWrite = exports.resolveIntersectingUrl = exports.renderPosterImage = exports.renderCaption = exports.opsPath = exports.getTitle = exports.getMediaType = exports.getImageOrientation = exports.getBookMetadata = exports.generateWebpubManifest = exports.forOf = exports.fileId = exports.fail = void 0;
-
-var _forEach = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/for-each"));
-
-var _entries = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/entries"));
-
+exports.validatePosterImage = exports.safeWrite = exports.resolveIntersectingUrl = exports.renderPosterImage = exports.renderCaption = exports.opsPath = exports.getTitle = exports.getMediaType = exports.getImageOrientation = exports.getBookMetadata = exports.generateWebpubManifest = exports.fileId = exports.fail = void 0;
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/promise"));
-
 var _map = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/map"));
-
 var _concat = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/concat"));
-
 var _reduce = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/reduce"));
-
 var _filter = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/filter"));
-
 var _url = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/url"));
-
 var _slice = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/slice"));
-
 var _map2 = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/map"));
-
 var _indexOf = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/index-of"));
-
 var _fsExtra = _interopRequireDefault(require("fs-extra"));
-
 var _path = _interopRequireDefault(require("path"));
-
 var _find = _interopRequireDefault(require("lodash/find"));
-
 var _uniq = _interopRequireDefault(require("lodash/uniq"));
-
 var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logger"));
-
 var _findIndex = _interopRequireDefault(require("lodash/findIndex"));
-
 var _mimeTypes = _interopRequireDefault(require("mime-types"));
-
 var _ = require("..");
-
 // import ffprobe from 'ffprobe'
 // import ffprobeStatic from 'ffprobe-static'
-// Get a file's relative path to the OPS
-const opsPath = (fpath, base) => fpath.replace(new RegExp(`^${base}${_path.default.sep}OPS${_path.default.sep}?`), ''); // https://www.w3.org/TR/xml-names/#Conformance
 
+// Get a file's relative path to the OPS
+const opsPath = (fpath, base) => fpath.replace(new RegExp(`^${base}${_path.default.sep}OPS${_path.default.sep}?`), '');
 
+// https://www.w3.org/TR/xml-names/#Conformance
 exports.opsPath = opsPath;
+const fileId = str => `_${str.replace(/[^a-zA-Z0-9_-]/g, '_')}`;
 
-const fileId = str => `_${str.replace(/[^a-zA-Z0-9_-]/g, '_')}`; // Determine an image's orientation
-
-
+// Determine an image's orientation
 exports.fileId = fileId;
-
 const getImageOrientation = (w, h) => {
   // assign image class based on w:h ratio
   const widthToHeight = w / h;
@@ -75,128 +49,99 @@ const getImageOrientation = (w, h) => {
   if (widthToHeight === 1) imageType = 'square';
   if (widthToHeight > 1) imageType = 'landscape';
   return imageType;
-}; // const getAspectRatioClassName = (key = '16:9') =>
+};
+
+// const getAspectRatioClassName = (key = '16:9') =>
 //     ({ '4:3': 'video--4x3', '16:9': 'video--16x9', '21:9': 'video--21x9' }[key])
+
 // export const getVideoAspectRatio = async filePath => {
 //     if (!filePath) return getAspectRatioClassName()
+
 //     const { streams } = await ffprobe(filePath, { path: ffprobeStatic.path })
 //     if (!streams) return getAspectRatioClassName()
 //     const { display_aspect_ratio: aspectRatio } = streams
 //     return getAspectRatioClassName(aspectRatio)
 // }
-// Create an iterator from object's key/value pairs
 
-
-exports.getImageOrientation = getImageOrientation;
-
-const forOf = (collection, iterator) => {
-  var _context;
-
-  return (0, _forEach.default)(_context = (0, _entries.default)(collection)).call(_context, ([key, val]) => iterator(key, val));
-}; // TODO: the whole figures/generated pages/user-configurable YAML thing should
+// TODO: the whole figures/generated pages/user-configurable YAML thing should
 // be worked out better. one reason is below, where we need the title of a
 // generated page, but since metadata is attached in the frontmatter YAML of an
 // MD file, there is no reference for the metadata.
 // @issue: https://github.com/triplecanopy/b-ber/issues/208
 //
 // this is provisional, will just cause more confusion in the future
-
-
-exports.forOf = forOf;
-
+exports.getImageOrientation = getImageOrientation;
 const getTitle = page => {
   if (page.name === 'figures-titlepage') return 'Figures';
-
   const meta = _.State.spine.frontMatter.get(page.name);
-
   return meta && meta.title ? meta.title : page.title || page.name;
 };
-
 exports.getTitle = getTitle;
-
 const getBookMetadata = term => {
   const entry = (0, _find.default)(_.State.metadata.json(), {
     term
   });
   if (entry && entry.value) return entry.value;
-
   _bBerLogger.default.warn(`Could not find metadata value for ${term}`);
-
   return '';
 };
-
 exports.getBookMetadata = getBookMetadata;
-
 const safeWrite = (dest, data) => _fsExtra.default.existsSync(dest) ? _promise.default.resolve() : _fsExtra.default.writeFile(dest, data);
-
 exports.safeWrite = safeWrite;
-
 const fail = (_msg, _err, yargs) => {
   yargs.showHelp();
   process.exit(0);
 };
-
 exports.fail = fail;
-
 const ensureDirs = (dirs, prefix) => {
-  var _context2, _context3;
-
+  var _context, _context2;
   const cwd = process.cwd();
-  const dirs_ = (0, _map.default)(_context2 = (0, _uniq.default)((0, _concat.default)(_context3 = [`${prefix}/_project`, `${prefix}/_project/_fonts`, `${prefix}/_project/_images`, `${prefix}/_project/_javascripts`, `${prefix}/_project/_markdown`, `${prefix}/_project/_media`, `${prefix}/_project/_stylesheets`, `${prefix}/themes`]).call(_context3, dirs))).call(_context2, a => _fsExtra.default.ensureDir(_path.default.join(cwd, a)));
+  const dirs_ = (0, _map.default)(_context = (0, _uniq.default)((0, _concat.default)(_context2 = [`${prefix}/_project`, `${prefix}/_project/_fonts`, `${prefix}/_project/_images`, `${prefix}/_project/_javascripts`, `${prefix}/_project/_markdown`, `${prefix}/_project/_media`, `${prefix}/_project/_stylesheets`, `${prefix}/themes`]).call(_context2, dirs))).call(_context, a => _fsExtra.default.ensureDir(_path.default.join(cwd, a)));
   return _promise.default.all(dirs_);
 };
-
 const ensureFiles = (files, prefix) => {
-  var _context4, _context5, _context6;
-
-  const files_ = (0, _reduce.default)(_context4 = (0, _concat.default)(_context5 = (0, _filter.default)(_context6 = [{
+  var _context3, _context4, _context5;
+  const files_ = (0, _reduce.default)(_context3 = (0, _concat.default)(_context4 = (0, _filter.default)(_context5 = [{
     absolutePath: _path.default.resolve(prefix, '_project', 'toc.yml'),
     content: ''
-  }]).call(_context6, ({
+  }]).call(_context5, ({
     absolutePath
   }) => (0, _findIndex.default)(files, {
     absolutePath
-  }) < 0)).call(_context5, files)).call(_context4, (acc, curr) => _fsExtra.default.existsSync(curr.absolutePath) ? acc : (0, _concat.default)(acc).call(acc, _fsExtra.default.writeFile(curr.absolutePath, curr.content)), []);
+  }) < 0)).call(_context4, files)).call(_context3, (acc, curr) => _fsExtra.default.existsSync(curr.absolutePath) ? acc : (0, _concat.default)(acc).call(acc, _fsExtra.default.writeFile(curr.absolutePath, curr.content)), []);
   return _promise.default.all(files_);
-}; // make sure all necessary files and directories exist
-
+};
 
+// make sure all necessary files and directories exist
 const ensure = ({
   files = [],
   dirs = [],
   prefix = ''
 } = {}) => ensureDirs(dirs, prefix).then(() => ensureFiles(files, prefix)).catch(_bBerLogger.default.error);
-
 exports.ensure = ensure;
-
 const trimLeadingSlash = s => s.replace(/^\//, '');
-
 const resolveIntersectingUrl = (u, p) => {
-  var _context7, _context8;
-
+  var _context6, _context7;
   let url;
-
   try {
     url = new _url.default(u);
   } catch (err) {
     _bBerLogger.default.warn(`${err.message}: "${u}"`);
-
     return u;
   }
-
   const {
     pathname
   } = url;
-  let urlParts = (0, _filter.default)(_context7 = pathname.split('/')).call(_context7, Boolean);
-  let pathParts = (0, _filter.default)(_context8 = p.split('/')).call(_context8, Boolean); // Remove filename if there is one
+  let urlParts = (0, _filter.default)(_context6 = pathname.split('/')).call(_context6, Boolean);
+  let pathParts = (0, _filter.default)(_context7 = p.split('/')).call(_context7, Boolean);
 
+  // Remove filename if there is one
   if (/\./.test(urlParts[urlParts.length - 1])) {
     urlParts.pop();
-  } // Find indices where to slice arrays
-
+  }
 
+  // Find indices where to slice arrays
   let intersectionIndices = [];
-
   for (let i = 0; i < urlParts.length; i++) {
     for (let j = 0; j < pathParts.length; j++) {
       if (urlParts[i] === pathParts[j]) {
@@ -205,7 +150,6 @@ const resolveIntersectingUrl = (u, p) => {
       }
     }
   }
-
   const [uIdx, pIdx] = intersectionIndices;
   urlParts = (0, _slice.default)(urlParts).call(urlParts, 0, uIdx);
   pathParts = (0, _slice.default)(pathParts).call(pathParts, pIdx);
@@ -213,9 +157,7 @@ const resolveIntersectingUrl = (u, p) => {
   url.pathname = intersection.join('/');
   return url.href;
 };
-
 exports.resolveIntersectingUrl = resolveIntersectingUrl;
-
 const webpubManifestResource = base => file => {
   const href = resolveIntersectingUrl(base, file);
   return {
@@ -223,7 +165,6 @@ const webpubManifestResource = base => file => {
     type: _mimeTypes.default.lookup(file)
   };
 };
-
 const webpubManifestReadingOrderItem = base => ({
   title,
   file
@@ -234,18 +175,18 @@ const webpubManifestReadingOrderItem = base => ({
     title,
     type: 'text/xhtml'
   };
-}; // https://github.com/readium/webpub-manifest
-
+};
 
+// https://github.com/readium/webpub-manifest
 const generateWebpubManifest = files => {
-  var _context9, _context10;
-
-  const remoteURL = _.Url.trimSlashes(_.State.config.remote_url); // Build a map to sort the files according to the position in the spine
-
+  var _context8, _context9;
+  const remoteURL = _.Url.trimSlashes(_.State.config.remote_url);
 
-  const fileMap = new _map2.default((0, _map.default)(files).call(files, f => [_path.default.basename(f), f])); // Create the items for the manifest's reading order
+  // Build a map to sort the files according to the position in the spine
+  const fileMap = new _map2.default((0, _map.default)(files).call(files, f => [_path.default.basename(f), f]));
 
-  const readingOrderItems = (0, _reduce.default)(_context9 = _.State.spine.flattened).call(_context9, (acc, curr) => {
+  // Create the items for the manifest's reading order
+  const readingOrderItems = (0, _reduce.default)(_context8 = _.State.spine.flattened).call(_context8, (acc, curr) => {
     const file = fileMap.get(`${curr.fileName}.xhtml`);
     return !file ? acc : (0, _concat.default)(acc).call(acc, {
       file,
@@ -253,7 +194,7 @@ const generateWebpubManifest = files => {
     });
   }, []);
   const readingOrder = (0, _map.default)(readingOrderItems).call(readingOrderItems, webpubManifestReadingOrderItem(remoteURL));
-  const resources = (0, _map.default)(_context10 = (0, _filter.default)(files).call(files, file => _path.default.basename(file).charAt(0) !== '.')).call(_context10, webpubManifestResource(remoteURL));
+  const resources = (0, _map.default)(_context9 = (0, _filter.default)(files).call(files, file => _path.default.basename(file).charAt(0) !== '.')).call(_context9, webpubManifestResource(remoteURL));
   const manifest = {
     '@context': 'https://readium.org/webpub-manifest/context.jsonld',
     metadata: {
@@ -269,49 +210,41 @@ const generateWebpubManifest = files => {
       rel: 'self',
       href: `${remoteURL}/${trimLeadingSlash(_.State.distDir)}/manifest.json`,
       type: 'application/webpub+json'
-    } // { rel: 'alternate', href: `${remoteURL}/publication.epub`, type: 'application/epub+zip' },
+    }
+    // { rel: 'alternate', href: `${remoteURL}/publication.epub`, type: 'application/epub+zip' },
     // { rel: 'search', href: `${remoteURL}/search{?query}`, type: 'text/html', templated: true },
     ],
+
     readingOrder,
     resources
   };
   return manifest;
-}; // b-ber-grammar-* utilities
-
+};
 
+// b-ber-grammar-* utilities
 exports.generateWebpubManifest = generateWebpubManifest;
-
 const validatePosterImage = (asset, type) => {
   const assetPath = _.State.src.images(asset);
-
   if (!_fsExtra.default.existsSync(assetPath)) {
     _bBerLogger.default.error(`bber-directives: Poster image for [${type}] does not exist`);
   }
-
   return asset;
 };
-
 exports.validatePosterImage = validatePosterImage;
-
 const renderPosterImage = poster => poster ? `<img src="${poster}" alt="Poster Image"/>` : '';
-
 exports.renderPosterImage = renderPosterImage;
-
 const renderCaption = (caption, mediaType) => caption ? `<p class="caption caption__${mediaType}">${caption}</p>` : '';
-
 exports.renderCaption = renderCaption;
-
 const getMediaType = type => {
   const index = (0, _indexOf.default)(type).call(type, '-');
   return index > -1 ? type.substring(0, index) : type;
-}; // Only render unsupported HTML for inline embeds since the unsupported figure
+};
+
+// Only render unsupported HTML for inline embeds since the unsupported figure
 // in the LOI is handled by b-ber-templates. Not great UI to have to click to
 // the LOI to see that something is unsupported, but vimeo directives should
 // mostly be managed by media.yml which supports fallbacks.
-
-
 exports.getMediaType = getMediaType;
-
 function createUnsupportedInline({
   id,
   commentStart,
@@ -334,21 +267,19 @@ function createUnsupportedInline({
     </section>
     ${commentEnd}`;
 }
-
 function ensureSource(obj, type, fileName, lineNumber) {
   if (!obj.source) {
     _bBerLogger.default.error(`Directive [${type}] requires a [source] attribute at [${fileName}:${lineNumber}]`);
   }
 }
-
 function ensurePoster(obj, type) {
   if (!obj.poster) return;
-  validatePosterImage(obj.poster, type); // eslint-disable-next-line no-param-reassign
-
+  validatePosterImage(obj.poster, type);
+  // eslint-disable-next-line no-param-reassign
   obj.poster = `../images/${encodeURIComponent(_path.default.basename(obj.poster))}`;
-} // Add mediaType to classes
-
+}
 
+// Add mediaType to classes
 function ensureSupportedClassNames(obj, supported) {
   // eslint-disable-next-line no-param-reassign
   obj.classes += ` embed ${supported(_.State.build) ? '' : 'un'}supported`;