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

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/State.js

@@ -64,7 +64,7 @@ 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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-lib",
-  "version": "3.0.8-nav-memo.4+d47a9aae",
+  "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-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-shapes-dublin-core": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-shapes-sequences": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-theme-sans": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-theme-serif": "3.0.8-nav-memo.4+d47a9aae",
+    "@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",
@@ -77,5 +77,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "d47a9aae74dec3e3225e363b2434c7abe0fcf21b"
+  "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,16 +200,16 @@ 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' },
@@ -223,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`);
   }
@@ -281,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`;
 }