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

package/Config.js

@@ -55,5 +55,4 @@ class Config {
     return (0, _defaultsDeep.default)(optionsClone, defaultOptionsClone);
   }
 }
-var _default = Config;
-exports.default = _default;
+var _default = exports.default = Config;

package/EbookConvert.js

@@ -70,7 +70,6 @@ function convert(options) {
   settings.bookPath = `"${_path.default.resolve(settings.outputPath, bookName)}"`;
   return checkForCalibre().then(() => convertDocument(settings)).catch(_bBerLogger.default.error);
 }
-var _default = {
+var _default = exports.default = {
   convert
-};
-exports.default = _default;
+};

package/GuideItem.js

@@ -16,5 +16,4 @@ class GuideItem {
     this.type = type;
   }
 }
-var _default = GuideItem;
-exports.default = _default;
+var _default = exports.default = GuideItem;

package/Html.js

@@ -21,5 +21,4 @@ class Html {
     return str_.replace(/[&<>"']/g, m => map[m]);
   }
 }
-var _default = Html;
-exports.default = _default;
+var _default = exports.default = Html;

package/HtmlToXml.js

@@ -249,5 +249,4 @@ class HtmlToXmlParser {
     parser.end();
   }
 }
-var _default = HtmlToXmlParser;
-exports.default = _default;
+var _default = exports.default = HtmlToXmlParser;

package/ManifestItemProperties.js

@@ -85,5 +85,4 @@ class ManifestItemProperties {
   }
 }
 (0, _defineProperty2.default)(ManifestItemProperties, "HTMLMimeTypes", ['text/html', 'application/xhtml+xml']);
-var _default = ManifestItemProperties;
-exports.default = _default;
+var _default = exports.default = 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
 ```

package/Spine.js

@@ -48,7 +48,6 @@ class Spine {
     this.nested = this.build((0, _entries.default)(this)); // nested navigation
     this.flattened = this.flattenNodes(this.nested); // one-dimensional page flow
   }
-
   build(entries = []) {
     const {
       buildType
@@ -131,5 +130,4 @@ class Spine {
     return entries;
   }
 }
-var _default = Spine;
-exports.default = _default;
+var _default = exports.default = Spine;

package/SpineItem.js

@@ -50,5 +50,4 @@ class SpineItem {
     this.type = ''; // frontmatter, backmatter, ec
   }
 }
-var _default = SpineItem;
-exports.default = _default;
+var _default = exports.default = SpineItem;

package/State.js

@@ -42,8 +42,8 @@ var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logg
 var _Yaml = _interopRequireDefault(require("./Yaml"));
 var _Config = _interopRequireDefault(require("./Config"));
 var _Spine = _interopRequireDefault(require("./Spine"));
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[_Symbol$toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[_Symbol$toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function ownKeys(e, r) { var t = _Object$keys(e); if (_Object$getOwnPropertySymbols) { var o = _Object$getOwnPropertySymbols(e); r && (o = _filterInstanceProperty2(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 _context4, _context5; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty2(_context4 = ownKeys(Object(t), !0)).call(_context4, function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(e, _Object$getOwnPropertyDescriptors(t)) : _forEachInstanceProperty2(_context5 = ownKeys(Object(t))).call(_context5, function (r) { _Object$defineProperty(e, r, _Object$getOwnPropertyDescriptor(t, r)); }); } return e; } /* eslint-disable no-continue */
 const themes = {
@@ -64,9 +64,8 @@ const skipInitialization = () => {
   argv.length < 3 ||
   // if there are insufficient arguments
   (0, _includes.default)(argv).call(argv, 'new') // if it's a new project
-  ;
+;
 };
-
 const SRC_DIR_IMAGES = '_images';
 const SRC_DIR_MARKDOWN = '_markdown';
 const SRC_DIR_STYLESHEETS = '_stylesheets';
@@ -396,5 +395,4 @@ class State {
     this.loadTheme();
   }
 }
-var _default = new State();
-exports.default = _default;
+var _default = exports.default = new State();

package/Template.js

@@ -17,5 +17,4 @@ class Template {}
 }), {
   template
 }).contents.toString());
-var _default = Template;
-exports.default = _default;
+var _default = exports.default = Template;

package/Theme.js

@@ -168,5 +168,4 @@ class Theme {}
   }
   return createProjectThemeDirectory(name).then(() => copyThemeAssets(theme)).then(() => updateConfig(name)).then(() => !force && _bBerLogger.default.notice(`Updated theme [${name}]`)).catch(_bBerLogger.default.error);
 });
-var _default = Theme;
-exports.default = _default;
+var _default = exports.default = Theme;

package/Url.js

@@ -7,7 +7,7 @@ _Object$defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
-var _class;
+var _Url;
 class Url {
   static trimSlashes(url) {
     return url.replace(/(^\/+|\/+$)/, '');
@@ -30,14 +30,13 @@ class Url {
     return url_;
   }
 }
-_class = Url;
+_Url = Url;
 (0, _defineProperty2.default)(Url, "removeTrailingSlash", str => {
   if (typeof str !== 'string') return '';
   return str.replace(/\/+$/, '');
 });
 (0, _defineProperty2.default)(Url, "addTrailingSlash", str => {
   if (typeof str !== 'string' || str === '/') return '/';
-  return `${_class.removeTrailingSlash(str)}/`;
+  return `${_Url.removeTrailingSlash(str)}/`;
 });
-var _default = Url;
-exports.default = _default;
+var _default = exports.default = Url;

package/Yaml.js

@@ -117,7 +117,6 @@ const interfaces = {
     }
     // TODO: fill this in with missing options
   },
-
   media: {}
 };
 function YawnAPI() {
@@ -172,5 +171,4 @@ class Yaml {
     this.schema = schema;
   }
 }
-var _default = Yaml;
-exports.default = _default;
+var _default = exports.default = Yaml;

package/YamlAdaptor.js

@@ -38,5 +38,4 @@ class YamlAdaptor {
     return _jsYaml.default.safeLoad(str);
   }
 }
-var _default = YamlAdaptor;
-exports.default = _default;
+var _default = exports.default = YamlAdaptor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-lib",
-  "version": "3.0.8-nav.0+24db1e6b",
+  "version": "3.0.8-next.61+2bbec564",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -28,11 +28,11 @@
   },
   "dependencies": {
     "@babel/runtime-corejs3": "^7.10.5",
-    "@canopycanopycanopy/b-ber-logger": "3.0.8-nav.0+24db1e6b",
-    "@canopycanopycanopy/b-ber-shapes-dublin-core": "3.0.8-nav.0+24db1e6b",
-    "@canopycanopycanopy/b-ber-shapes-sequences": "3.0.8-nav.0+24db1e6b",
-    "@canopycanopycanopy/b-ber-theme-sans": "3.0.8-nav.0+24db1e6b",
-    "@canopycanopycanopy/b-ber-theme-serif": "3.0.8-nav.0+24db1e6b",
+    "@canopycanopycanopy/b-ber-logger": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-shapes-dublin-core": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-shapes-sequences": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-theme-sans": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-theme-serif": "3.0.8-next.61+2bbec564",
     "command-exists": "^1.2.2",
     "fs-extra": "^8.1.0",
     "glob": "^7.1.4",
@@ -44,7 +44,7 @@
     "tar": "^6.1.11",
     "vinyl": "^2.2.0",
     "yargs": "^13.3.0",
-    "yawn-yaml": "^1.3.4"
+    "yawn-yaml": "1.5.0"
   },
   "files": [
     "utils",
@@ -77,5 +77,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "24db1e6bb491faae0d52c6dadc09d974a5a31cf5"
+  "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
 }

package/utils/index.js

@@ -27,7 +27,8 @@ 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("..");
+var _Url = _interopRequireDefault(require("../Url"));
+var _State = _interopRequireDefault(require("../State"));
 // import ffprobe from 'ffprobe'
 // import ffprobeStatic from 'ffprobe-static'
 
@@ -73,12 +74,12 @@ const getImageOrientation = (w, h) => {
 exports.getImageOrientation = getImageOrientation;
 const getTitle = page => {
   if (page.name === 'figures-titlepage') return 'Figures';
-  const meta = _.State.spine.frontMatter.get(page.name);
+  const meta = _State.default.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(), {
+  const entry = (0, _find.default)(_State.default.metadata.json(), {
     term
   });
   if (entry && entry.value) return entry.value;
@@ -180,13 +181,13 @@ const webpubManifestReadingOrderItem = base => ({
 // https://github.com/readium/webpub-manifest
 const generateWebpubManifest = files => {
   var _context8, _context9;
-  const remoteURL = _.Url.trimSlashes(_.State.config.remote_url);
+  const remoteURL = _Url.default.trimSlashes(_State.default.config.remote_url);
 
   // 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]));
 
   // Create the items for the manifest's reading order
-  const readingOrderItems = (0, _reduce.default)(_context8 = _.State.spine.flattened).call(_context8, (acc, curr) => {
+  const readingOrderItems = (0, _reduce.default)(_context8 = _State.default.spine.flattened).call(_context8, (acc, curr) => {
     const file = fileMap.get(`${curr.fileName}.xhtml`);
     return !file ? acc : (0, _concat.default)(acc).call(acc, {
       file,
@@ -199,22 +200,21 @@ const generateWebpubManifest = files => {
     '@context': 'https://readium.org/webpub-manifest/context.jsonld',
     metadata: {
       '@type': 'http://schema.org/Book',
-      title: getBookMetadata('title', _.State),
-      author: getBookMetadata('creator', _.State),
-      identifier: getBookMetadata('identifier', _.State),
-      language: getBookMetadata('language', _.State),
-      publisher: getBookMetadata('publisher', _.State),
+      title: getBookMetadata('title', _State.default),
+      author: getBookMetadata('creator', _State.default),
+      identifier: getBookMetadata('identifier', _State.default),
+      language: getBookMetadata('language', _State.default),
+      publisher: getBookMetadata('publisher', _State.default),
       modified: new Date().toISOString()
     },
     links: [{
       rel: 'self',
-      href: `${remoteURL}/${trimLeadingSlash(_.State.distDir)}/manifest.json`,
+      href: `${remoteURL}/${trimLeadingSlash(_State.default.distDir)}/manifest.json`,
       type: 'application/webpub+json'
     }
     // { rel: 'alternate', href: `${remoteURL}/publication.epub`, type: 'application/epub+zip' },
     // { rel: 'search', href: `${remoteURL}/search{?query}`, type: 'text/html', templated: true },
     ],
-
     readingOrder,
     resources
   };
@@ -224,7 +224,7 @@ const generateWebpubManifest = files => {
 // b-ber-grammar-* utilities
 exports.generateWebpubManifest = generateWebpubManifest;
 const validatePosterImage = (asset, type) => {
-  const assetPath = _.State.src.images(asset);
+  const assetPath = _State.default.src.images(asset);
   if (!_fsExtra.default.existsSync(assetPath)) {
     _bBerLogger.default.error(`bber-directives: Poster image for [${type}] does not exist`);
   }
@@ -282,5 +282,5 @@ function ensurePoster(obj, type) {
 // Add mediaType to classes
 function ensureSupportedClassNames(obj, supported) {
   // eslint-disable-next-line no-param-reassign
-  obj.classes += ` embed ${supported(_.State.build) ? '' : 'un'}supported`;
+  obj.classes += ` embed ${supported(_State.default.build) ? '' : 'un'}supported`;
 }