@canopycanopycanopy/b-ber-templates 3.0.8-nav.0 → 3.0.8-next.96

package/README.md

@@ -1,9 +1,25 @@
-# `@canopycanopycanopy/b-ber-templates`
+# b-ber-templates
 
-The `b-ber-templates` package contains templates for different types of content that b-ber outputs during I/O operations.
+Provides JavaScript template classes used by the b-ber build pipeline to generate EPUB structural files and figure markup. Each class exposes static methods that return either XML/HTML strings or Vinyl file objects containing `{% body %}` placeholders that the build pipeline fills in. Templates cover EPUB 3 structural formats (OPF package, NCX navigation, XHTML pages, container XML) as well as project scaffolding files and per-build-target figure markup.
 
-## Install
+## Contents
 
-```
-$ npm i -g @canopycanopycanopy/b-ber-templates
+| Path                                                                     | Purpose                                                                                                                                    |
+| ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| `src/Ncx/`                                                               | EPUB 2 NCX navigation document (head, docTitle, navMap, navPoints)                                                                         |
+| `src/Opf/`                                                               | EPUB 3 OPF package: `Pkg`, `Metadata`, `Manifest`, `Spine`, `Guide`                                                                        |
+| `src/Ops/`                                                               | Returns the `application/epub+zip` MIME type string                                                                                        |
+| `src/Toc/`                                                               | EPUB 3 `nav` TOC element with nested `<ol>` item rendering                                                                                 |
+| `src/Xhtml/`                                                             | XHTML page template: head, body, stylesheet/script link tags, cover SVG, LOI section                                                       |
+| `src/Xml/`                                                               | EPUB `META-INF/container.xml` and mimetype string                                                                                          |
+| `src/Project/`                                                           | Scaffolding for new projects: directory layout, `toc.yml`, `metadata.yml`, starter Markdown files, `config.yml`, `.gitignore`, `README.md` |
+| `src/figures/`                                                           | Per-build-target figure markup: `epub`, `mobi`, `reader`, `web`; dispatches by media type (image orientation, audio, video, iframe, vimeo) |
+| `Ncx/`, `Opf/`, `Ops/`, `Toc/`, `Xhtml/`, `Xml/`, `figures/`, `Project/` | Built output of `src/` (generated by `npm run build`)                                                                                      |
+
+## Dev
+
+```bash
+npm test       # runs jest; snapshot tests for Toc, Xhtml, Xml, Project, and figure variants
+npm run build  # transpiles src/ to output directories via Babel
+npm run watch  # watch mode for development
 ```

package/dist/Guide-DtZekBN_.d.ts

@@ -0,0 +1,19 @@
+import File from "vinyl";
+
+//#region src/Opf/Guide.d.ts
+declare class Guide {
+  static body(): File.BufferFile;
+  static item({
+    type,
+    title,
+    href
+  }: {
+    type: any;
+    title: any;
+    href: any;
+  }): string;
+  static items(data: any): any;
+}
+//#endregion
+export { Guide as t };
+//# sourceMappingURL=Guide-DtZekBN_.d.ts.map

package/dist/Guide-DtZekBN_.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Guide-DtZekBN_.d.ts","names":[],"sources":["../src/Opf/Guide.ts"],"mappings":";;;cAKM,KAAA;EAAA,OACG,IAAA,IAAI,IAAA,CAAA,UAAA;EAAA,OAOJ,IAAA;IAAO,IAAA;IAAM,KAAA;IAAO;EAAA;;;;;SAIpB,KAAA,CAAM,IAAA;AAAA"}

package/dist/Manifest-xzjWoNoJ.d.ts

@@ -0,0 +1,10 @@
+import File from "vinyl";
+
+//#region src/Opf/Manifest.d.ts
+declare class Manifest {
+  static body(): File.BufferFile;
+  static item(file: any): string;
+}
+//#endregion
+export { Manifest as t };
+//# sourceMappingURL=Manifest-xzjWoNoJ.d.ts.map

package/dist/Manifest-xzjWoNoJ.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Manifest-xzjWoNoJ.d.ts","names":[],"sources":["../src/Opf/Manifest.ts"],"mappings":";;;cAcM,QAAA;EAAA,OACG,IAAA,IAAI,IAAA,CAAA,UAAA;EAAA,OAOJ,IAAA,CAAK,IAAA;AAAA"}

package/dist/Metadata-Cv6mesgj.d.ts

@@ -0,0 +1,11 @@
+import File from "vinyl";
+
+//#region src/Opf/Metadata.d.ts
+declare class Metadata {
+  static uid(): string;
+  static body(): File.BufferFile;
+  static meta(data: any): string;
+}
+//#endregion
+export { Metadata as t };
+//# sourceMappingURL=Metadata-Cv6mesgj.d.ts.map

package/dist/Metadata-Cv6mesgj.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metadata-Cv6mesgj.d.ts","names":[],"sources":["../src/Opf/Metadata.ts"],"mappings":";;;cAWM,QAAA;EAAA,OACG,GAAA;EAAA,OAIA,IAAA,IAAI,IAAA,CAAA,UAAA;EAAA,OAOJ,IAAA,CAAK,IAAA;AAAA"}

package/dist/Ncx/index.d.ts

@@ -0,0 +1,13 @@
+import File from "vinyl";
+
+//#region src/Ncx/index.d.ts
+declare class Ncx {
+  static head(): string;
+  static title(): string;
+  static author(): string;
+  static document(): File.BufferFile;
+  static navPoint(data: any): string;
+  static navPoints(data: any): any;
+}
+export = Ncx;
+//# sourceMappingURL=index.d.ts.map

package/dist/Ncx/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/Ncx/index.ts"],"mappings":";;;cAOM,GAAA;EAAA,OACG,IAAA;EAAA,OAaA,KAAA;EAAA,OAUA,MAAA;EAAA,OAUA,QAAA,IAAQ,IAAA,CAAA,UAAA;EAAA,OAgBR,QAAA,CAAS,IAAA;EAAA,OAST,SAAA,CAAU,IAAA;AAAA;AAAA"}

package/dist/Ncx/index.js

@@ -0,0 +1,83 @@
+const require_chunk = require("../chunk-DakpK96I.js");
+let _canopycanopycanopy_b_ber_lib = require("@canopycanopycanopy/b-ber-lib");
+let lodash_find_js = require("lodash/find.js");
+lodash_find_js = require_chunk.__toESM(lodash_find_js);
+let lodash_has_js = require("lodash/has.js");
+lodash_has_js = require_chunk.__toESM(lodash_has_js);
+let vinyl = require("vinyl");
+vinyl = require_chunk.__toESM(vinyl);
+//#region src/Ncx/index.ts
+const { getTitle } = _canopycanopycanopy_b_ber_lib.utils;
+var Ncx = class Ncx {
+	static head() {
+		const entry = (0, lodash_find_js.default)(_canopycanopycanopy_b_ber_lib.State.metadata.json(), { term: "identifier" });
+		return `
+      <head>
+        <meta name="dtb:uid" content="${entry && (0, lodash_has_js.default)(entry, "value") ? entry.value : ""}"/>
+        <meta name="dtb:depth" content="1"/>
+        <meta name="dtb:totalPageCount" content="1"/>
+        <meta name="dtb:maxPageNumber" content="1"/>
+      </head>
+    `;
+	}
+	static title() {
+		const entry = (0, lodash_find_js.default)(_canopycanopycanopy_b_ber_lib.State.metadata.json(), { term: "title" });
+		const title = entry && (0, lodash_has_js.default)(entry, "value") ? entry.value : "";
+		return `
+      <docTitle>
+        <text>${_canopycanopycanopy_b_ber_lib.Html.escape(title)}</text>
+      </docTitle>
+    `;
+	}
+	static author() {
+		const entry = (0, lodash_find_js.default)(_canopycanopycanopy_b_ber_lib.State.metadata.json(), { term: "creator" });
+		const creator = entry && (0, lodash_has_js.default)(entry, "value") ? entry.value : "";
+		return `
+      <docAuthor>
+        <text>${_canopycanopycanopy_b_ber_lib.Html.escape(creator)}</text>
+      </docAuthor>
+    `;
+	}
+	static document() {
+		return new vinyl.default({
+			path: "ncx.document.tmpl",
+			contents: Buffer.from(`<?xml version="1.0" encoding="UTF-8"?>
+        <ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1">
+          ${Ncx.head()}
+          ${Ncx.title()}
+          ${Ncx.author()}
+          <navMap>
+            {% body %}
+          </navMap>
+        </ncx>
+      `)
+		});
+	}
+	static navPoint(data) {
+		return `
+      <navLabel>
+        <text>${_canopycanopycanopy_b_ber_lib.Html.escape(getTitle(data))}</text>
+      </navLabel>
+      <content src="${data.relativePath}.xhtml" />
+    `;
+	}
+	static navPoints(data) {
+		let index = 0;
+		function render(nodes) {
+			if (!nodes || !nodes.length) return "";
+			return nodes.reduce((acc, curr) => {
+				if (curr.in_toc === false) return acc;
+				index += 1;
+				return acc.concat(`
+          <navPoint id="navPoint-${index}" playOrder="${index}">
+            ${Ncx.navPoint(curr)}
+            ${render(curr.nodes)}
+          </navPoint>
+        `);
+			}, "");
+		}
+		return render(data);
+	}
+};
+//#endregion
+module.exports = Ncx;

package/dist/Opf/Guide.d.ts

@@ -0,0 +1,2 @@
+import { t as Guide } from "../Guide-DtZekBN_.js";
+export = Guide;

package/dist/Opf/Guide.js

@@ -0,0 +1,36 @@
+const require_chunk = require("../chunk-DakpK96I.js");
+let _canopycanopycanopy_b_ber_lib = require("@canopycanopycanopy/b-ber-lib");
+let vinyl = require("vinyl");
+vinyl = require_chunk.__toESM(vinyl);
+let _canopycanopycanopy_b_ber_logger = require("@canopycanopycanopy/b-ber-logger");
+_canopycanopycanopy_b_ber_logger = require_chunk.__toESM(_canopycanopycanopy_b_ber_logger);
+let path = require("path");
+path = require_chunk.__toESM(path);
+//#region src/Opf/Guide.ts
+var Guide = class Guide {
+	static body() {
+		return new vinyl.default({
+			path: "guide.body.tmpl",
+			contents: Buffer.from("<guide>{% body %}</guide>")
+		});
+	}
+	static item({ type, title, href }) {
+		return `<reference type="${type}" title="${title}" href="${href}"/>`;
+	}
+	static items(data) {
+		return data.reduce((acc, curr) => {
+			if (!curr.type) return acc;
+			_canopycanopycanopy_b_ber_logger.default.info(`guide adding landmark [${curr.fileName}] as [${curr.type}]`);
+			const { type } = curr;
+			const title = _canopycanopycanopy_b_ber_lib.Html.escape(curr.title);
+			const href = `text/${encodeURI(path.default.basename(curr.fileName, ".xhtml"))}.xhtml`;
+			return acc.concat(Guide.item({
+				type,
+				title,
+				href
+			}));
+		}, "");
+	}
+};
+//#endregion
+module.exports = Guide;

package/dist/Opf/Manifest.d.ts

@@ -0,0 +1,2 @@
+import { t as Manifest } from "../Manifest-xzjWoNoJ.js";
+export = Manifest;

package/dist/Opf/Manifest.js

@@ -0,0 +1,26 @@
+const require_chunk = require("../chunk-DakpK96I.js");
+let _canopycanopycanopy_b_ber_lib = require("@canopycanopycanopy/b-ber-lib");
+let vinyl = require("vinyl");
+vinyl = require_chunk.__toESM(vinyl);
+let mime_types = require("mime-types");
+mime_types = require_chunk.__toESM(mime_types);
+//#region src/Opf/Manifest.ts
+const { fileId } = _canopycanopycanopy_b_ber_lib.utils;
+const getProps = (file) => {
+	const props = _canopycanopycanopy_b_ber_lib.ManifestItemProperties.testHTML(file);
+	return props && props.length ? `properties="${props.join(" ")}"` : "";
+};
+const getMediaType = ({ remote, absolutePath }) => remote ? "application/octet-stream" : mime_types.default.lookup(absolutePath);
+var Manifest = class {
+	static body() {
+		return new vinyl.default({
+			path: "manifest.body.tmpl",
+			contents: Buffer.from("<manifest>{% body %}</manifest>")
+		});
+	}
+	static item(file) {
+		return `<item id="${fileId(file.name)}" href="${encodeURI(file.opsPath)}" media-type="${getMediaType(file)}" ${getProps(file)}/>`;
+	}
+};
+//#endregion
+module.exports = Manifest;

package/dist/Opf/Metadata.d.ts

@@ -0,0 +1,2 @@
+import { t as Metadata } from "../Metadata-Cv6mesgj.js";
+export = Metadata;

package/dist/Opf/Metadata.js

@@ -0,0 +1,55 @@
+const require_chunk = require("../chunk-DakpK96I.js");
+let _canopycanopycanopy_b_ber_lib = require("@canopycanopycanopy/b-ber-lib");
+let vinyl = require("vinyl");
+vinyl = require_chunk.__toESM(vinyl);
+let _canopycanopycanopy_b_ber_logger = require("@canopycanopycanopy/b-ber-logger");
+_canopycanopycanopy_b_ber_logger = require_chunk.__toESM(_canopycanopycanopy_b_ber_logger);
+let crypto = require("crypto");
+crypto = require_chunk.__toESM(crypto);
+//#region src/Opf/Metadata.ts
+const { fileId } = _canopycanopycanopy_b_ber_lib.utils;
+var Metadata = class Metadata {
+	static uid() {
+		return `_${crypto.default.randomBytes(8).toString("hex")}`;
+	}
+	static body() {
+		return new vinyl.default({
+			path: "metadata.body.tmpl",
+			contents: Buffer.from("<metadata>{% body %}</metadata>")
+		});
+	}
+	static meta(data) {
+		const { term, element } = _canopycanopycanopy_b_ber_lib.ManifestItemProperties.testMeta(data);
+		const itemid = element && data.term === "identifier" ? "uuid" : Metadata.uid();
+		let res = [];
+		if (term) res.push(`<meta property="dcterms:${data.term}">${_canopycanopycanopy_b_ber_lib.Html.escape(data.value)}</meta>`);
+		if (element) res.push(`<dc:${data.term} id="${itemid}">${_canopycanopycanopy_b_ber_lib.Html.escape(data.value)}</dc:${data.term}>`);
+		if (data.refines) {
+			const refines = data.refines.reduce((acc, curr) => acc.concat(Object.entries(curr).map(([key, value]) => `<meta refines="#${itemid}" property="${key}">${_canopycanopycanopy_b_ber_lib.Html.escape(value)}</meta>`)), []);
+			res = res.concat(refines);
+		}
+		if (term && element && data.term_property && data.term_property_value) {
+			let message = "\n";
+			message += "You're using an outdated syntax in `metadata.yml` which will be removed in future versions.";
+			message += "\nUpdate the entries in the `metadata.yml` file to use the new `refines` syntax:";
+			message += `
+
+                  -   - term: ${data.term}
+                  -     value: ${data.value}
+                  -     term_property: ${data.term_property}
+                  -     term_property_value: ${data.term_property_value}
+                  +    - term: ${data.term}
+                  +      value: ${data.value}
+                  +      - refines:
+                  +        - ${data.term_property}: ${data.term_property_value}
+                  `;
+			_canopycanopycanopy_b_ber_logger.default.notice(message);
+			res.push(`<meta refines="#${itemid}" property="${data.term_property}">${_canopycanopycanopy_b_ber_lib.Html.escape(data.term_property_value)}</meta>`);
+		}
+		if (!term && !element) if (data.term !== "cover") res.push(`<meta name="${data.term}" content="${_canopycanopycanopy_b_ber_lib.Html.escape(data.value)}"/>`);
+		else res.push(`<meta name="${data.term}" content="${fileId(_canopycanopycanopy_b_ber_lib.Html.escape(data.value))}"/>`);
+		return res.join("");
+	}
+};
+//#endregion
+module.exports = Metadata;

package/dist/Opf/Pkg.d.ts

@@ -0,0 +1,2 @@
+import { t as Pkg } from "../Pkg-BAwlpc2n.js";
+export = Pkg;

package/dist/Opf/Pkg.js

@@ -0,0 +1,26 @@
+const require_chunk = require("../chunk-DakpK96I.js");
+let vinyl = require("vinyl");
+vinyl = require_chunk.__toESM(vinyl);
+//#region src/Opf/Pkg.ts
+var Pkg = class {
+	static body() {
+		return new vinyl.default({
+			path: "pkg.body.tmpl",
+			contents: Buffer.from(`<?xml version="1.0" encoding="UTF-8"?>
+                <package
+                    version="3.0"
+                    xml:lang="en"
+                    unique-identifier="uuid"
+                    xmlns="http://www.idpf.org/2007/opf"
+                    xmlns:dc="http://purl.org/dc/elements/1.1/"
+                    xmlns:dcterms="http://purl.org/dc/terms/"
+                    prefix="ibooks: http://vocabulary.itunes.apple.com/rdf/ibooks/vocabulary-extensions-1.0/"
+                >
+                    {% body %}
+                </package>
+            `)
+		});
+	}
+};
+//#endregion
+module.exports = Pkg;

package/dist/Opf/Spine.d.ts

@@ -0,0 +1,2 @@
+import { t as Spine } from "../Spine-B4MQP83_.js";
+export = Spine;

package/dist/Opf/Spine.js

@@ -0,0 +1,43 @@
+const require_chunk = require("../chunk-DakpK96I.js");
+let _canopycanopycanopy_b_ber_lib = require("@canopycanopycanopy/b-ber-lib");
+let vinyl = require("vinyl");
+vinyl = require_chunk.__toESM(vinyl);
+let _canopycanopycanopy_b_ber_logger = require("@canopycanopycanopy/b-ber-logger");
+_canopycanopycanopy_b_ber_logger = require_chunk.__toESM(_canopycanopycanopy_b_ber_logger);
+let path = require("path");
+path = require_chunk.__toESM(path);
+//#region src/Opf/Spine.ts
+const { fileId } = _canopycanopycanopy_b_ber_lib.utils;
+var Spine = class Spine {
+	static body() {
+		return new vinyl.default({
+			path: "spine.body.tmpl",
+			contents: Buffer.from("<spine toc=\"_toc_ncx\">{% body %}</spine>")
+		});
+	}
+	static item({ fileName, extension, linear }) {
+		return `<itemref idref="${fileId(path.default.basename(fileName, extension))}_xhtml" linear="${linear ? "yes" : "no"}"/>`;
+	}
+	static items(data) {
+		return data.reduce((acc, curr) => {
+			const { fileName } = curr;
+			if (curr.linear === false) {
+				if (_canopycanopycanopy_b_ber_lib.State.build === "mobi") {
+					_canopycanopycanopy_b_ber_logger.default.info(`opf templates/spine omitting non-linear asset [${fileName}] for mobi build`);
+					return acc;
+				}
+				_canopycanopycanopy_b_ber_logger.default.info(`opf templates/spine writing non-linear asset [${fileName}]`);
+			}
+			if (fileName === "figures-titlepage") {
+				_canopycanopycanopy_b_ber_logger.default.info("opf templates/spine writing [loi]");
+				if (_canopycanopycanopy_b_ber_lib.State.loi.length) return acc.concat(_canopycanopycanopy_b_ber_lib.State.loi.reduce((acc2, curr2) => acc2.concat(Spine.item({
+					...curr2,
+					linear: true
+				})), Spine.item(curr)));
+			}
+			return acc.concat(Spine.item(curr));
+		}, "");
+	}
+};
+//#endregion
+module.exports = Spine;

package/dist/Pkg-BAwlpc2n.d.ts

@@ -0,0 +1,9 @@
+import File from "vinyl";
+
+//#region src/Opf/Pkg.d.ts
+declare class Pkg {
+  static body(): File.BufferFile;
+}
+//#endregion
+export { Pkg as t };
+//# sourceMappingURL=Pkg-BAwlpc2n.d.ts.map

package/dist/Pkg-BAwlpc2n.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pkg-BAwlpc2n.d.ts","names":[],"sources":["../src/Opf/Pkg.ts"],"mappings":";;;cAEM,GAAA;EAAA,OACG,IAAA,IAAI,IAAA,CAAA,UAAA;AAAA"}

package/dist/Project/index.d.ts

@@ -0,0 +1,44 @@
+//#region src/Project/index.d.ts
+declare class Project {
+  static directories(src: string): string[];
+  static relativePath(src: string, ...rest: string[]): string;
+  static absolutePath(src: string, ...rest: string[]): string;
+  static configYAML(src: string, config?: Record<string, any>): {
+    relativePath: string;
+    absolutePath: string;
+    content: string;
+  };
+  static tocYAML(src: string): {
+    relativePath: string;
+    absolutePath: string;
+    content: string;
+  };
+  static metadataYAML(src: string): {
+    relativePath: string;
+    absolutePath: string;
+    content: string;
+  };
+  static javascripts(src: string): Array<{
+    relativePath: string;
+    absolutePath: string;
+    content: string;
+  }>;
+  static markdown(src: string): Array<{
+    relativePath: string;
+    absolutePath: string;
+    content: string;
+  }>;
+  static stylesheets(): never[];
+  static readme(src: string): {
+    relativePath: string;
+    absolutePath: string;
+    content: string;
+  };
+  static gitignore(src: string): {
+    relativePath: string;
+    absolutePath: string;
+    content: string;
+  };
+}
+export = Project;
+//# sourceMappingURL=index.d.ts.map

package/dist/Project/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/Project/index.ts"],"mappings":";cAYM,OAAA;EAAA,OACG,WAAA,CAAY,GAAA;EAAA,OAYZ,YAAA,CAAa,GAAA,aAAgB,IAAA;EAAA,OAI7B,YAAA,CAAa,GAAA,aAAgB,IAAA;EAAA,OAI7B,UAAA,CACL,GAAA,UACA,MAAA,GAAQ,MAAA;IACL,YAAA;IAAsB,YAAA;IAAsB,OAAA;EAAA;EAAA,OAQ1C,OAAA,CAAQ,GAAA;IACb,YAAA;IACA,YAAA;IACA,OAAA;EAAA;EAAA,OASK,YAAA,CAAa,GAAA;IAClB,YAAA;IACA,YAAA;IACA,OAAA;EAAA;EAAA,OAYK,WAAA,CACL,GAAA,WACC,KAAA;IAAQ,YAAA;IAAsB,YAAA;IAAsB,OAAA;EAAA;EAAA,OAkBhD,QAAA,CACL,GAAA,WACC,KAAA;IAAQ,YAAA;IAAsB,YAAA;IAAsB,OAAA;EAAA;EAAA,OA4ChD,WAAA;EAAA,OAIA,MAAA,CAAO,GAAA;IACZ,YAAA;IACA,YAAA;IACA,OAAA;EAAA;EAAA,OAYK,SAAA,CAAU,GAAA;IACf,YAAA;IACA,YAAA;IACA,OAAA;EAAA;AAAA;AAAA"}

package/dist/Project/index.js

@@ -0,0 +1,2 @@
+const require_Project = require("../Project-D0Q1l_Vp.js");
+module.exports = require_Project.Project;