@canopycanopycanopy/b-ber-lib 3.0.8-nav.0 → 3.0.8-next.101

package/EbookConvert.js

@@ -1,76 +1,2 @@
-"use strict";
-
-var _Object$keys = require("@babel/runtime-corejs3/core-js-stable/object/keys");
-var _Object$getOwnPropertySymbols = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols");
-var _filterInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/filter");
-var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor");
-var _forEachInstanceProperty2 = require("@babel/runtime-corejs3/core-js-stable/instance/for-each");
-var _Object$getOwnPropertyDescriptors = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors");
-var _Object$defineProperties = require("@babel/runtime-corejs3/core-js-stable/object/define-properties");
-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.default = void 0;
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
-var _promise = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/promise"));
-var _forEach = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/for-each"));
-var _path = _interopRequireDefault(require("path"));
-var _has = _interopRequireDefault(require("lodash/has"));
-var _child_process = require("child_process");
-var _commandExists = _interopRequireDefault(require("command-exists"));
-var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logger"));
-function ownKeys(e, r) { var t = _Object$keys(e); if (_Object$getOwnPropertySymbols) { var o = _Object$getOwnPropertySymbols(e); r && (o = _filterInstanceProperty(o).call(o, function (r) { return _Object$getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context, _context2; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty2(_context = ownKeys(Object(t), !0)).call(_context, function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(e, _Object$getOwnPropertyDescriptors(t)) : _forEachInstanceProperty2(_context2 = ownKeys(Object(t))).call(_context2, function (r) { _Object$defineProperty(e, r, _Object$getOwnPropertyDescriptor(t, r)); }); } return e; }
-const command = 'ebook-convert';
-const defaults = {
-  inputPath: null,
-  outputPath: null,
-  fileType: null,
-  // any format supported by `ebook-convert`
-  fileName: new Date().toISOString().replace(/:/g, '-'),
-  flags: []
-};
-function checkForCalibre() {
-  return new _promise.default((resolve, reject) => {
-    (0, _commandExists.default)(command, (err, ok) => {
-      if (err || !ok) {
-        return reject(new Error("Error: calibre's ebook-convert must be installed. Download calibre here: https://calibre-ebook.com/"));
-      }
-      resolve();
-    });
-  });
-}
-function convertDocument({
-  inputPath,
-  bookPath,
-  flags
-}) {
-  return new _promise.default((resolve, reject) => {
-    (0, _child_process.exec)(`${command} ${inputPath} ${bookPath} ${flags.join(' ')}`, {
-      cwd: process.cwd()
-    }, (err, stdout, stderr) => {
-      if (err) return reject(err);
-      if (stderr !== '') process.stdout.write(stderr);
-      if (stdout !== '') process.stdout.write(stdout);
-      resolve();
-    });
-  });
-}
-function convert(options) {
-  const props = ['inputPath', 'outputPath', 'fileType'];
-  (0, _forEach.default)(props).call(props, prop => {
-    if (!(0, _has.default)(options, prop)) {
-      throw new Error(`Missing required option [${prop}]`);
-    }
-  });
-  const settings = _objectSpread(_objectSpread({}, defaults), options);
-  const bookName = `${settings.fileName}.${settings.fileType.replace(/^\./, '')}`;
-  settings.bookPath = `"${_path.default.resolve(settings.outputPath, bookName)}"`;
-  return checkForCalibre().then(() => convertDocument(settings)).catch(_bBerLogger.default.error);
-}
-var _default = {
-  convert
-};
-exports.default = _default;
+'use strict';
+module.exports = require('./dist/index.js').EbookConvert;

package/Html.js

@@ -1,25 +1,2 @@
-"use strict";
-
-var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
-_Object$defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-class Html {
-  static comment(str) {
-    return `\n<!-- ${str} -->\n`;
-  }
-  static escape(str) {
-    const str_ = typeof str !== 'string' ? String(str) : str;
-    const map = {
-      '&': '&amp;',
-      '<': '&lt;',
-      '>': '&gt;',
-      '"': '&quot;',
-      "'": '&#39;'
-    };
-    return str_.replace(/[&<>"']/g, m => map[m]);
-  }
-}
-var _default = Html;
-exports.default = _default;
+'use strict';
+module.exports = require('./dist/index.js').Html;

package/HtmlToXml.js

@@ -1,253 +1,2 @@
-"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.default = void 0;
-var _bind = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/bind"));
-var _reduce = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/reduce"));
-var _entries = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/entries"));
-var _concat = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/concat"));
-var _set = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/set"));
-var _trim = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/trim"));
-var _path = _interopRequireDefault(require("path"));
-var _htmlparser = require("htmlparser2");
-var _State = _interopRequireDefault(require("./State"));
-class HtmlToXmlParser {
-  constructor({
-    content,
-    onEndCallback
-  }) {
-    var _context, _context2, _context3, _context4;
-    this.customElementNames = {
-      pullquote: true,
-      blockquote: true,
-      epigraph: true,
-      dialogue: true,
-      gallery: true,
-      spread: true,
-      colophon: true,
-      appendix: true,
-      subtitle: true,
-      frontmatter: true,
-      backmatter: true,
-      'meta-content': true,
-      bibliography: true,
-      masthead: true,
-      figcaption: true,
-      subchapter: true
-    };
-    this.inlineElementNames = {
-      pagebreak: true,
-      a: false,
-      abbr: true,
-      acronym: true,
-      audio: false,
-      b: true,
-      bdi: true,
-      bdo: true,
-      big: true,
-      br: false,
-      button: false,
-      canvas: true,
-      cite: true,
-      code: true,
-      data: true,
-      datalist: true,
-      del: true,
-      dfn: true,
-      em: true,
-      embed: false,
-      i: true,
-      iframe: false,
-      img: false,
-      input: false,
-      ins: true,
-      kbd: true,
-      label: false,
-      map: true,
-      mark: true,
-      meter: true,
-      noscript: false,
-      object: false,
-      output: true,
-      picture: false,
-      progress: false,
-      q: true,
-      ruby: true,
-      s: true,
-      samp: true,
-      script: false,
-      select: false,
-      slot: true,
-      small: true,
-      span: true,
-      strong: true,
-      sub: true,
-      sup: true,
-      svg: true,
-      template: true,
-      textarea: false,
-      time: true,
-      u: true,
-      tt: true,
-      var: true,
-      video: false,
-      wbr: true
-    };
-    this.whitelistedAttributes = {
-      src: true,
-      href: true,
-      'xlink:href': true,
-      xmlns: true,
-      'xmlns:xlink': true,
-      class: true
-    };
-    this.blacklistedTagNames = {
-      html: true,
-      head: true,
-      title: true,
-      meta: true,
-      link: true,
-      script: true,
-      body: true,
-      video: true,
-      audio: true
-    };
-    this.containingTagNames = {
-      div: true,
-      span: true,
-      section: true
-    };
-    this.elementAttributeNames = {
-      img: {
-        src: 'href'
-      },
-      source: {
-        src: 'href'
-      }
-    };
-    this.elementAttributeTransformers = {
-      img: {
-        src: value => `file://${_path.default.resolve(_State.default.dist.images(_path.default.basename(value)))}`
-      },
-      source: {
-        src: value => `file://${_path.default.resolve(_State.default.dist.media(_path.default.basename(value)))}`
-      }
-    };
-    this.content = content;
-    this.onEndCallback = onEndCallback;
-    this.output = '';
-    this.tagList = [];
-    this.onopentag = (0, _bind.default)(_context = this.onopentag).call(_context, this);
-    this.ontext = (0, _bind.default)(_context2 = this.ontext).call(_context2, this);
-    this.onclosetag = (0, _bind.default)(_context3 = this.onclosetag).call(_context3, this);
-    this.onend = (0, _bind.default)(_context4 = this.onend).call(_context4, this);
-  }
-  writePageBreak() {
-    this.output += '<pagebreak></pagebreak>';
-  }
-  writeXMLDeclaration() {
-    this.output += '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>';
-  }
-  renameAttribute(name, attribute) {
-    if (!this.elementAttributeNames[name]) return attribute;
-    return this.elementAttributeNames[name][attribute] || attribute;
-  }
-  transformAttributeValue(name, attribute, value) {
-    if (!this.elementAttributeTransformers[name] || !this.elementAttributeTransformers[name][attribute]) {
-      return value;
-    }
-    return this.elementAttributeTransformers[name][attribute](value);
-  }
-  writeTagOpen(name, attributes = {}) {
-    var _context5;
-    let tag = [name];
-    tag = (0, _reduce.default)(_context5 = (0, _entries.default)(attributes)).call(_context5, (acc, [key, val]) => this.whitelistedAttributes[key] ? (0, _concat.default)(acc).call(acc, `${this.renameAttribute(name, key)}="${this.transformAttributeValue(name, key, val)}"`) : acc, tag);
-    if (attributes.class) {
-      const classNames = new _set.default(attributes.class.split(' '));
-      if (classNames.has('figure__large') && classNames.has('figure__inline') || classNames.has('gallery__item')) {
-        this.writePageBreak();
-      }
-    }
-    tag = tag.join(' ');
-    this.output += `<${tag}>`;
-  }
-  writeTagClose(name) {
-    this.output += `</${name}>`;
-    if (!this.inlineElementNames[name]) this.output += '\n';
-  }
-  addTag(name) {
-    this.tagList.push(name);
-  }
-  removeTag() {
-    return this.tagList.pop();
-  }
-  getTag() {
-    if (!this.tagList.length) return null;
-    return this.tagList[this.tagList.length - 1];
-  }
-  onopentag(name, attributes = {}) {
-    if (this.blacklistedTagNames[name]) return;
-    if (name === 'body') {
-      // Special case for body
-      if (attributes.class) {
-        // eslint-disable-next-line no-param-reassign
-        name = attributes.class.replace(/\s+/g, '-');
-      }
-    } else if (name === 'source') {
-      // Handle both audio and video elements' source tags. The audio and video
-      // elements themselves are blacklisted, so the child sources are used as
-      // the XML tags for the mp3/mp4s. Only allow mp3/mp4 file extensions since
-      // those are the only formats supported by INDD.
-      if (!attributes.src || !/\.mp[34]$/i.test(attributes.src)) {
-        return;
-      }
-    } else if (this.containingTagNames[name]) {
-      // Generic tag
-      if (attributes.class) {
-        const classNames = attributes.class.split(' ');
-        for (let i = 0; i < classNames.length; i++) {
-          if (this.customElementNames[classNames[i]]) {
-            // eslint-disable-next-line no-param-reassign
-            name = classNames[i];
-          }
-        }
-      }
-    }
-    this.addTag(name);
-    this.writeTagOpen(name, attributes);
-  }
-  ontext(text) {
-    if (!(0, _trim.default)(text).call(text)) return;
-    const name = this.getTag();
-    if (!name || this.blacklistedTagNames[name]) return;
-    this.output += text;
-  }
-  onclosetag() {
-    const name = this.removeTag();
-    if (name) this.writeTagClose(name);
-  }
-  onend() {
-    this.writeTagClose('body');
-    this.onEndCallback(this.output);
-  }
-  parse() {
-    this.writeXMLDeclaration();
-    this.writeTagOpen('body');
-    const parser = new _htmlparser.Parser({
-      onclosetag: this.onclosetag,
-      onopentag: this.onopentag,
-      ontext: this.ontext,
-      onend: this.onend
-    }, {
-      decodeEntities: false
-    });
-    parser.write(this.content);
-    parser.end();
-  }
-}
-var _default = HtmlToXmlParser;
-exports.default = _default;
+'use strict';
+module.exports = require('./dist/index.js').HtmlToXml;

package/ManifestItemProperties.js

@@ -1,89 +1,2 @@
-"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.default = void 0;
-var _includes = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/includes"));
-var _indexOf = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/index-of"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
-var _mimeTypes = _interopRequireDefault(require("mime-types"));
-var _has = _interopRequireDefault(require("lodash/has"));
-var _bBerShapesDublinCore = require("@canopycanopycanopy/b-ber-shapes-dublin-core");
-// Class to detect XML media-type properties based on the content of XHTML documents
-class ManifestItemProperties {
-  // Detect if a file is an (X)HTML document
-  static isHTML(file) {
-    var _context;
-    return (0, _includes.default)(_context = ManifestItemProperties.HTMLMimeTypes).call(_context, _mimeTypes.default.lookup(file.absolutePath));
-  }
-
-  // Detect if a file is an ePub navigation document
-  static isNav(file) {
-    return ManifestItemProperties.isHTML(file) && /^toc\./.test(file.name);
-  }
-
-  // Detect if an XHTML file contains JavaScript
-  static isScripted(file) {
-    if (!ManifestItemProperties.isHTML(file)) return false;
-
-    // TODO: fixme; we need to check if the toc.xhtml is scripted, but it
-    // hasn't been written to disk yet.  checking right now against the
-    // results from `state.template.dynamicTail` for now, since we know
-    // that the toc was written using that
-    // @issue: https://github.com/triplecanopy/b-ber/issues/206
-    if (ManifestItemProperties.isNav(file)) return true;
-    const contents = _fsExtra.default.readFileSync(file.absolutePath, 'utf8');
-    return contents.match(/<script/) !== null;
-  }
-
-  // Detect if an XHTML file contains SVG
-  static isSVG(file) {
-    if (!ManifestItemProperties.isHTML(file)) return false;
-    const contents = _fsExtra.default.readFileSync(file.absolutePath, 'utf8');
-    return contents.match(/<svg/) !== null;
-  }
-
-  // Detect if a term is a Dublin Core `element`
-  static isDCElement(data) {
-    return (0, _has.default)(data, 'term') && (0, _indexOf.default)(_bBerShapesDublinCore.elements).call(_bBerShapesDublinCore.elements, data.term) > -1;
-  }
-
-  // Detect if a term is a Dublin Core `term`
-  static isDCTerm(data) {
-    return (0, _has.default)(data, 'term') && (0, _indexOf.default)(_bBerShapesDublinCore.terms).call(_bBerShapesDublinCore.terms, data.term) > -1;
-  }
-
-  // Detect if an XHTML file contains remote resources
-  static hasRemoteResources(file) {
-    if (!ManifestItemProperties.isHTML(file)) return false;
-    const contents = _fsExtra.default.readFileSync(file.absolutePath, 'utf8');
-    return contents.match(/src=(?:['"]{1})?(?:http|\/\/)/) !== null;
-  }
-
-  // Test if an XHTML file is a navigation document, contains JavaScript or SVG
-  static testHTML(file) {
-    const props = [];
-    if (ManifestItemProperties.isNav(file)) props.push('nav');
-    if (ManifestItemProperties.isScripted(file)) props.push('scripted');
-    if (ManifestItemProperties.isSVG(file)) props.push('svg');
-    if (ManifestItemProperties.hasRemoteResources(file)) {
-      props.push('remote-resources');
-    }
-    return props;
-  }
-
-  // Test if an object contains Dublin Core `term`s or `element`s
-  static testMeta(data) {
-    return {
-      term: ManifestItemProperties.isDCTerm(data),
-      element: ManifestItemProperties.isDCElement(data)
-    };
-  }
-}
-(0, _defineProperty2.default)(ManifestItemProperties, "HTMLMimeTypes", ['text/html', 'application/xhtml+xml']);
-var _default = ManifestItemProperties;
-exports.default = _default;
+'use strict';
+module.exports = require('./dist/index.js').ManifestItemProperties;

package/README.md

@@ -1,9 +1,27 @@
 # `@canopycanopycanopy/b-ber-lib`
 
-The `b-ber-lib` package includes classes and modules for managing b-ber's internal state, performing I/O operations, and parsing and rendering YAML and JSON data.
+`b-ber-lib` is the shared utility library used across the b-ber build pipeline. It provides the central `State` singleton (project configuration, spine, metadata, and src/dist path helpers), `Config` (settings merged from `config.yml`), `Spine` and `SpineItem` (ordered content navigation built from `toc.yml`), `Theme` (SCSS theme loading), and a set of lower-level helpers for URL normalisation, HTML serialisation, YAML I/O, EPUB manifest properties, and Calibre ebook conversion. Virtually every other b-ber package depends on this package.
 
-## Install
+## Key exports
 
-```
-$ npm i -g @canopycanopycanopy/b-ber-lib
+| Export                   | Purpose                                                                                                |
+| ------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `State`                  | Singleton holding full build state: config, spine, metadata, figures, footnotes, src/dist path helpers |
+| `Config`                 | Constructs project config by deep-merging `config.yml` over defaults                                   |
+| `Spine` / `SpineItem`    | Reads `toc.yml`; produces nested and flattened page-flow for each build type                           |
+| `YamlAdaptor`            | Loads and queries YAML files; supports comment-preserving write-back via yawn-yaml                     |
+| `Html` / `HtmlToXml`     | Helpers for serialising and converting HTML to XHTML                                                   |
+| `Url`                    | URL normalisation utilities                                                                            |
+| `Theme`                  | Resolves and loads built-in or user-defined SCSS themes                                                |
+| `Template`               | Wraps rendered body content in the XHTML page template                                                 |
+| `ManifestItemProperties` | Derives EPUB manifest `properties` attributes from content                                             |
+| `GuideItem`              | Represents an EPUB guide reference entry                                                               |
+| `EbookConvert`           | Shell wrapper for the Calibre `ebook-convert` binary                                                   |
+| `utils`                  | Miscellaneous low-level helpers                                                                        |
+
+## Dev
+
+```bash
+npm test      # jest
+npm run build
 ```