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

package/README.md

@@ -1,9 +1,39 @@
 # `@canopycanopycanopy/b-ber-tasks`
 
-The `b-ber-tasks` package contains modules used for b-ber's I/O operations.
+`b-ber-tasks` defines every individual build step in the b-ber pipeline. Each task is an async function (Promise-based) that reads from and writes to the shared `State` object in `b-ber-lib`. `b-ber-cli` composes these tasks into ordered sequences to produce EPUB, Mobi, PDF, web, reader, and XML builds. The package also includes tasks for serving the output locally via browser-sync, deploying to remote hosts, and generating the full-text Lunr search index.
 
-## Install
+## Key exports
 
-```
-$ npm i -g @canopycanopycanopy/b-ber-tasks
+| Export      | Purpose                                                    |
+| ----------- | ---------------------------------------------------------- |
+| `render`    | Converts Markdown source files to XHTML pages              |
+| `opf`       | Generates the EPUB OPF (manifest, metadata, spine, guide)  |
+| `container` | Creates the EPUB `META-INF/container.xml`                  |
+| `epub`      | Zips the OPS directory into a `.epub` archive              |
+| `sass`      | Compiles SCSS to CSS with autoprefixer                     |
+| `scripts`   | Bundles and minifies JavaScript assets                     |
+| `copy`      | Copies static assets (images, fonts, media) into the build |
+| `cover`     | Generates the EPUB cover image entry                       |
+| `footnotes` | Collects and renders footnote pages                        |
+| `loi`       | Generates the List of Illustrations page                   |
+| `generate`  | Generates placeholder XHTML files for non-Markdown content |
+| `inject`    | Injects navigation and UI elements into rendered HTML      |
+| `init`      | Scaffolds a new b-ber project directory                    |
+| `clean`     | Removes build output directories                           |
+| `mobi`      | Runs Calibre conversion to produce `.mobi`                 |
+| `pdf`       | Produces PDF output                                        |
+| `web`       | Builds the static website output                           |
+| `reader`    | Builds the reader-compatible output                        |
+| `xml`       | Builds the InDesign XML output                             |
+| `sample`    | Builds the sample (excerpt) output                         |
+| `serve`     | Starts a browser-sync dev server                           |
+| `deploy`    | Deploys build output to a remote host                      |
+| `validate`  | Validates directive syntax in Markdown source              |
+| `serialize` | Serialises the spine/TOC data structure                    |
+
+## Dev
+
+```bash
+npm test      # jest
+npm run build
 ```

package/dist/opf/Opf.js

@@ -13,13 +13,17 @@ var _vinyl = _interopRequireDefault(require("vinyl"));
 var _State = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/State"));
 var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logger"));
 var _Pkg = _interopRequireDefault(require("@canopycanopycanopy/b-ber-templates/Opf/Pkg"));
-var _ = require(".");
+var _ManifestAndMetadata = _interopRequireDefault(require("./ManifestAndMetadata"));
+var _Navigation = _interopRequireDefault(require("./Navigation"));
 // Generates metadata, manifest, guide, and spine XML and writes to to `content.opf`
 
+// eslint-disable-line import/no-unresolved
+// eslint-disable-line import/no-unresolved
+
 class Opf {
   static createOpf() {
-    const manifestAndMetadata = new _.ManifestAndMetadata();
-    return _promise.default.all([manifestAndMetadata.init(), _.Navigation.init()]).then(Opf.createOpfPackageString).then(Opf.writeOPF).catch(_bBerLogger.default.error);
+    const manifestAndMetadata = new _ManifestAndMetadata.default();
+    return _promise.default.all([manifestAndMetadata.init(), _Navigation.default.init()]).then(Opf.createOpfPackageString).then(Opf.writeOPF).catch(_bBerLogger.default.error);
   }
   static writeOPF(contents) {
     const opsPath = _State.default.dist.ops('content.opf');

package/dist/serialize.js

@@ -12,9 +12,8 @@ var _reduce = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-sta
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/promise"));
 var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logger"));
 var _State = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/State"));
-var tasks = _interopRequireWildcard(require(".."));
-function _getRequireWildcardCache(e) { if ("function" != typeof _WeakMap) return null; var r = new _WeakMap(), t = new _WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = _Object$defineProperty && _Object$getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? _Object$getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? _Object$defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+var tasks = _interopRequireWildcard(require("./task-handlers"));
+function _interopRequireWildcard(e, t) { if ("function" == typeof _WeakMap) var r = new _WeakMap(), n = new _WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = _Object$defineProperty) && _Object$getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 // This is basically the engine of our application. `serialize` is responsible
 // for taking in the list of tasks that need to be run, calling their
 // associated handlers, handling errors if any are encountered, and then

package/dist/serve/index.js

@@ -12,7 +12,9 @@ var _State = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/State
 var _sequences = _interopRequireDefault(require("@canopycanopycanopy/b-ber-shapes-sequences/sequences"));
 var _debounce = _interopRequireDefault(require("lodash/debounce"));
 var _browserSync = require("browser-sync");
-var _ = require("..");
+var _serialize = _interopRequireDefault(require("../serialize"));
+// eslint-disable-line import/no-unresolved
+
 const browserSync = (0, _browserSync.create)();
 const port = 4000;
 const debounceSpeed = 500;
@@ -23,7 +25,7 @@ const config = build => url => () => {
   _State.default.update('config.base_path', '/');
   _State.default.update('config.remote_url', url);
   _State.default.update('config.reader_url', url);
-  return (0, _.serialize)(_sequences.default[build]);
+  return (0, _serialize.default)(_sequences.default[build]);
 };
 
 // Declared below once browserSync has been initialized

package/dist/task-handlers.js

@@ -0,0 +1,168 @@
+"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
+});
+_Object$defineProperty(exports, "clean", {
+  enumerable: true,
+  get: function () {
+    return _clean.default;
+  }
+});
+_Object$defineProperty(exports, "container", {
+  enumerable: true,
+  get: function () {
+    return _container.default;
+  }
+});
+_Object$defineProperty(exports, "copy", {
+  enumerable: true,
+  get: function () {
+    return _copy.default;
+  }
+});
+_Object$defineProperty(exports, "cover", {
+  enumerable: true,
+  get: function () {
+    return _cover.default;
+  }
+});
+_Object$defineProperty(exports, "deploy", {
+  enumerable: true,
+  get: function () {
+    return _deploy.default;
+  }
+});
+_Object$defineProperty(exports, "epub", {
+  enumerable: true,
+  get: function () {
+    return _epub.default;
+  }
+});
+_Object$defineProperty(exports, "footnotes", {
+  enumerable: true,
+  get: function () {
+    return _footnotes.default;
+  }
+});
+_Object$defineProperty(exports, "generate", {
+  enumerable: true,
+  get: function () {
+    return _generate.default;
+  }
+});
+_Object$defineProperty(exports, "init", {
+  enumerable: true,
+  get: function () {
+    return _init.default;
+  }
+});
+_Object$defineProperty(exports, "inject", {
+  enumerable: true,
+  get: function () {
+    return _inject.default;
+  }
+});
+_Object$defineProperty(exports, "loi", {
+  enumerable: true,
+  get: function () {
+    return _loi.default;
+  }
+});
+_Object$defineProperty(exports, "mobi", {
+  enumerable: true,
+  get: function () {
+    return _mobi.default;
+  }
+});
+_Object$defineProperty(exports, "mobiCSS", {
+  enumerable: true,
+  get: function () {
+    return _mobiCss.default;
+  }
+});
+_Object$defineProperty(exports, "opf", {
+  enumerable: true,
+  get: function () {
+    return _opf.default;
+  }
+});
+_Object$defineProperty(exports, "pdf", {
+  enumerable: true,
+  get: function () {
+    return _pdf.default;
+  }
+});
+_Object$defineProperty(exports, "reader", {
+  enumerable: true,
+  get: function () {
+    return _reader.default;
+  }
+});
+_Object$defineProperty(exports, "render", {
+  enumerable: true,
+  get: function () {
+    return _render.default;
+  }
+});
+_Object$defineProperty(exports, "sample", {
+  enumerable: true,
+  get: function () {
+    return _sample.default;
+  }
+});
+_Object$defineProperty(exports, "sass", {
+  enumerable: true,
+  get: function () {
+    return _sass.default;
+  }
+});
+_Object$defineProperty(exports, "scripts", {
+  enumerable: true,
+  get: function () {
+    return _scripts.default;
+  }
+});
+_Object$defineProperty(exports, "validate", {
+  enumerable: true,
+  get: function () {
+    return _validate.default;
+  }
+});
+_Object$defineProperty(exports, "web", {
+  enumerable: true,
+  get: function () {
+    return _web.default;
+  }
+});
+_Object$defineProperty(exports, "xml", {
+  enumerable: true,
+  get: function () {
+    return _xml.default;
+  }
+});
+var _clean = _interopRequireDefault(require("./clean"));
+var _container = _interopRequireDefault(require("./container"));
+var _copy = _interopRequireDefault(require("./copy"));
+var _cover = _interopRequireDefault(require("./cover"));
+var _deploy = _interopRequireDefault(require("./deploy"));
+var _epub = _interopRequireDefault(require("./epub"));
+var _footnotes = _interopRequireDefault(require("./footnotes"));
+var _generate = _interopRequireDefault(require("./generate"));
+var _init = _interopRequireDefault(require("./init"));
+var _inject = _interopRequireDefault(require("./inject"));
+var _loi = _interopRequireDefault(require("./loi"));
+var _mobi = _interopRequireDefault(require("./mobi"));
+var _mobiCss = _interopRequireDefault(require("./mobi/mobi-css"));
+var _opf = _interopRequireDefault(require("./opf"));
+var _pdf = _interopRequireDefault(require("./pdf"));
+var _render = _interopRequireDefault(require("./render"));
+var _sample = _interopRequireDefault(require("./sample"));
+var _sass = _interopRequireDefault(require("./sass"));
+var _scripts = _interopRequireDefault(require("./scripts"));
+var _web = _interopRequireDefault(require("./web"));
+var _xml = _interopRequireDefault(require("./xml"));
+var _reader = _interopRequireDefault(require("./reader"));
+var _validate = _interopRequireDefault(require("./validate"));

package/dist/validate/index.js

@@ -17,8 +17,7 @@ var _path = _interopRequireDefault(require("path"));
 var _State = _interopRequireDefault(require("@canopycanopycanopy/b-ber-lib/State"));
 var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logger"));
 var _bBerValidator = _interopRequireWildcard(require("@canopycanopycanopy/b-ber-validator"));
-function _getRequireWildcardCache(e) { if ("function" != typeof _WeakMap) return null; var r = new _WeakMap(), t = new _WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = _Object$defineProperty && _Object$getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? _Object$getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? _Object$defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof _WeakMap) var r = new _WeakMap(), n = new _WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = _Object$defineProperty) && _Object$getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
 const validate = async ({
   project
 }) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-tasks",
-  "version": "3.0.8-nav-memo.4+d47a9aae",
+  "version": "3.0.8-next.61+2bbec564",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -19,14 +19,14 @@
   },
   "dependencies": {
     "@babel/runtime-corejs3": "^7.10.5",
-    "@canopycanopycanopy/b-ber-lib": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-logger": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-markdown-renderer": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-reader": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-resources": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-shapes-sequences": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-templates": "3.0.8-nav-memo.4+d47a9aae",
-    "@canopycanopycanopy/b-ber-validator": "3.0.8-nav-memo.4+d47a9aae",
+    "@canopycanopycanopy/b-ber-lib": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-logger": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-markdown-renderer": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-reader": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-resources": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-shapes-sequences": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-templates": "3.0.8-next.61+2bbec564",
+    "@canopycanopycanopy/b-ber-validator": "3.0.8-next.61+2bbec564",
     "autoprefixer": "^9.6.1",
     "browser-sync": "^2.27.7",
     "bs-html-injector": "^3.0.3",
@@ -76,5 +76,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "d47a9aae74dec3e3225e363b2434c7abe0fcf21b"
+  "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
 }