postext 1.4.1 → 1.5.0

package/dist/bundle/book.d.ts

@@ -1,4 +1,4 @@
-import type { PostextConfig, Resource } from '../types';
+import type { DocumentMetadata, PostextConfig, Resource } from '../types';
 import type { VDTDocument } from '../vdt';
 import type { BuildDocumentOptions } from '../pipeline';
 import type { MeasurementCache } from '../measure';
@@ -9,6 +9,11 @@ export interface BuildBundleOptions extends BuildDocumentOptions {
     /** Measurement cache shared by every chapter; one is created when
      *  omitted. */
     cache?: MeasurementCache;
+    /** Book metadata (`{title}`, `{author}`, the PDF title…) handed to every
+     *  chapter. The first chapter's front matter is the book's and wins over
+     *  these values; a front-matter block at the top of a later chapter is
+     *  ignored, as in the Sandbox. */
+    metadata?: DocumentMetadata;
     /** Called after each chapter is laid out (the last round's, when the
      *  contents take several). */
     onChapter?: (index: number, doc: VDTDocument) => void;

package/dist/bundle/book.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"book.d.ts","sourceRoot":"","sources":["../../src/bundle/book.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAoC,aAAa,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAC1F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,iEAAiE;IACjE,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB;mBACe;IACf,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB;kCAC8B;IAC9B,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,KAAK,IAAI,CAAC;CACvD;AAMD;;uCAEuC;AACvC,wBAAgB,WAAW,CACzB,MAAM,EAAE;IAAE,QAAQ,EAAE,SAAS,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,EAAE,CAAC;IAAC,MAAM,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAA;CAAE,EACvH,OAAO,GAAE,kBAAuB,GAC/B,WAAW,EAAE,CA6Cf"}
+{"version":3,"file":"book.d.ts","sourceRoot":"","sources":["../../src/bundle/book.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,gBAAgB,EAAoC,aAAa,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAC5G,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAGnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,iEAAiE;IACjE,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB;mBACe;IACf,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB;;;sCAGkC;IAClC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B;kCAC8B;IAC9B,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,KAAK,IAAI,CAAC;CACvD;AA2CD;;uCAEuC;AACvC,wBAAgB,WAAW,CACzB,MAAM,EAAE;IAAE,QAAQ,EAAE,SAAS,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,EAAE,CAAC;IAAC,MAAM,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAA;CAAE,EACvH,OAAO,GAAE,kBAAuB,GAC/B,WAAW,EAAE,CAwEf"}

package/dist/bundle/book.js

@@ -1,52 +1,124 @@
 // Lay a bundle's book out chapter by chapter, the way the Sandbox does:
 // each chapter continues the one before it (heading and resource counters,
-// the open part, page parity and page numbering), and a chapter printing
-// the contents (`:::toc`) receives the whole book's outline.
+// the open part, page parity and page numbering), every chapter reads the
+// book's metadata (the first chapter's front matter), a chapter printing
+// the contents (`:::toc`) receives the whole book's outline, and
+// `{bookTotalPages}` counts the whole book.
 import { buildDocument, continuationAfter, contentOutline, outlineFromDoc, outlineKey } from '../pipeline';
 import { createMeasurementCache } from '../measure';
+import { extractFrontmatter } from '../frontmatter';
+import { configUsesPlaceholder } from '../design/placeholders';
 /** How many times the book is laid out at most while the contents' page
  *  numbers settle. */
 const MAX_ROUNDS = 3;
+const FRONTMATTER_OPEN_RE = /^---[ \t]*(?:\r?\n|$)/;
+/** `markdown` with a leading front-matter block blanked out — every
+ *  character but the line breaks turned into a space, so source offsets
+ *  stay as they were and the engine parses no metadata from it. The block
+ *  is found by its lines alone, never parsed (the Sandbox's rule, which
+ *  mirrors gray-matter's): the first line is exactly `---`, and the block
+ *  closes at the next line that is exactly `---`. */
+function blankFrontmatter(markdown) {
+    const open = FRONTMATTER_OPEN_RE.exec(markdown);
+    if (!open || (open[0].length >= markdown.length && !open[0].endsWith('\n')))
+        return markdown;
+    let pos = open[0].length;
+    while (pos <= markdown.length) {
+        const nl = markdown.indexOf('\n', pos);
+        const lineEnd = nl === -1 ? markdown.length : nl;
+        if (markdown.slice(pos, lineEnd).replace(/\r$/, '') === '---') {
+            const end = nl === -1 ? markdown.length : nl + 1;
+            return markdown.slice(0, end).replace(/[^\n\r]/g, ' ') + markdown.slice(end);
+        }
+        if (nl === -1)
+            break;
+        pos = nl + 1;
+    }
+    return markdown;
+}
+/** The label and book index of the first page of `doc` holding a block —
+ *  past the parity blanks before its opener; undefined for a document
+ *  with no content. */
+function firstContentPage(doc) {
+    let first;
+    for (const b of doc.blocks) {
+        if (b.pageIndex >= 0 && (first === undefined || b.pageIndex < first))
+            first = b.pageIndex;
+    }
+    const page = first !== undefined ? doc.pages[first] : undefined;
+    return page ? { pageLabel: page.pageLabel, pageIndex: (doc.pageIndexOffset ?? 0) + page.index } : undefined;
+}
 /** Lay out every chapter of `bundle`, in order; returns one `VDTDocument`
  *  per chapter. Hand the array to `renderToPdf` for the whole book, or
  *  paint `docs[i]` for one chapter. */
 export function buildBundle(bundle, options = {}) {
-    const { config: configOverride, cache: sharedCache, onChapter, ...buildOptions } = options;
+    const { config: configOverride, cache: sharedCache, onChapter, metadata: givenMetadata, ...buildOptions } = options;
     const config = configOverride ?? bundle.config;
     const resources = [...bundle.resources];
     const cache = sharedCache ?? createMeasurementCache();
     const chapters = bundle.chapters;
-    const hasToc = chapters.map((c) => contentOutline({ markdown: c.markdown }, config).hasToc);
+    // The book's metadata: the first chapter's front matter over the given
+    // values. Later chapters' front matter is not the book's.
+    const first = chapters[0];
+    const metadata = { ...(givenMetadata ?? {}), ...(first ? extractFrontmatter(first.markdown).metadata : {}) };
+    const sources = chapters.map((c, index) => (index === 0 ? c.markdown : blankFrontmatter(c.markdown)));
+    const hasToc = sources.map((markdown) => contentOutline({ markdown }, config).hasToc);
     const anyToc = hasToc.some(Boolean);
+    // `{bookTotalPages}` needs the page count of the whole book, known once
+    // every chapter is laid out: the book goes round once more with it. It
+    // never moves a page break, so one more round settles it.
+    const usesBookTotal = configUsesPlaceholder(config, 'bookTotalPages');
     let outline;
+    let bookPageCount;
     let docs = [];
-    for (let round = 0; round < MAX_ROUNDS; round++) {
+    for (let round = 0;; round++) {
         docs = [];
         const continuations = [];
         let counters;
         let physical = 0;
         let next;
-        chapters.forEach((chapter, index) => {
+        const total = bookPageCount !== undefined ? { bookPageCount } : {};
+        sources.forEach((markdown, index) => {
             const continuation = index === 0
-                ? undefined
-                : { ...counters, pageIndexOffset: physical, ...(next ? { pageNumbering: next } : {}) };
-            const doc = buildDocument({ markdown: chapter.markdown, resources, ...(continuation ? { continuation } : {}), ...(hasToc[index] && outline ? { outline } : {}) }, config, cache, buildOptions);
+                ? (bookPageCount !== undefined ? total : undefined)
+                : { ...counters, pageIndexOffset: physical, ...(next ? { pageNumbering: next } : {}), ...total };
+            const doc = buildDocument({ markdown, metadata, resources, ...(continuation ? { continuation } : {}), ...(hasToc[index] && outline ? { outline } : {}) }, config, cache, buildOptions);
             docs.push(doc);
             continuations.push(continuation);
             const last = doc.pages[doc.pages.length - 1];
             physical += doc.pages.length;
             if (last)
                 next = { startAt: last.pageNumberValue + 1, format: last.pageNumberFormat };
-            counters = continuationAfter({ markdown: chapter.markdown, resources }, config, counters);
+            counters = continuationAfter({ markdown, resources }, config, counters);
         });
-        if (!anyToc)
-            break;
-        const bookOutline = chapters.flatMap((chapter, index) => outlineFromDoc(docs[index], contentOutline({ markdown: chapter.markdown }, config, continuations[index]).outline));
-        if (outline && outlineKey(outline) === outlineKey(bookOutline))
+        // Another round for the contents while their page labels move (at
+        // most MAX_ROUNDS layouts), and for the book's page count while the
+        // one printed is not the one laid out (at most one more).
+        let outlineMoved = false;
+        if (anyToc) {
+            const bookOutline = sources.flatMap((markdown, index) => {
+                const entries = outlineFromDoc(docs[index], contentOutline({ markdown }, config, continuations[index]).outline);
+                // A part that reached no page of its chapter — set without a
+                // divider page (`parts.page: false`) by a fence closing the
+                // chapter — starts with the next chapter's content, as its running
+                // heads do.
+                if (!entries.some((e) => e.kind === 'part' && e.pageIndex === undefined))
+                    return entries;
+                const next = docs.slice(index + 1).map(firstContentPage).find((p) => p !== undefined);
+                return next ? entries.map((e) => (e.kind === 'part' && e.pageIndex === undefined ? { ...e, ...next } : e)) : entries;
+            });
+            outlineMoved = !outline || outlineKey(outline) !== outlineKey(bookOutline);
+            // The first round laid the contents out from its own chapter alone:
+            // always lay the book out once more with the whole outline.
+            if (outlineMoved)
+                outline = bookOutline;
+        }
+        const totalMoved = usesBookTotal && bookPageCount !== physical;
+        if (usesBookTotal)
+            bookPageCount = physical;
+        const again = (outlineMoved && round + 1 < MAX_ROUNDS) || (totalMoved && round + 1 < MAX_ROUNDS + 1);
+        if (!again)
             break;
-        outline = bookOutline;
-        // The first round laid the contents out from its own chapter alone:
-        // always lay the book out once more with the whole outline.
     }
     if (onChapter)
         docs.forEach((doc, index) => onChapter(index, doc));

package/dist/bundle/book.js.map

@@ -1 +1 @@
-{"version":3,"file":"book.js","sourceRoot":"","sources":["../../src/bundle/book.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,2EAA2E;AAC3E,yEAAyE;AACzE,6DAA6D;AAI7D,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE3G,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAepD;sBACsB;AACtB,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB;;uCAEuC;AACvC,MAAM,UAAU,WAAW,CACzB,MAAuH,EACvH,UAA8B,EAAE;IAEhC,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;IAC3F,MAAM,MAAM,GAAG,cAAc,IAAI,MAAM,CAAC,MAAM,CAAC;IAC/C,MAAM,SAAS,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,WAAW,IAAI,sBAAsB,EAAE,CAAC;IACtD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;IAC5F,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEpC,IAAI,OAAmC,CAAC;IACxC,IAAI,IAAI,GAAkB,EAAE,CAAC;IAC7B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,UAAU,EAAE,KAAK,EAAE,EAAE,CAAC;QAChD,IAAI,GAAG,EAAE,CAAC;QACV,MAAM,aAAa,GAAuC,EAAE,CAAC;QAC7D,IAAI,QAAwC,CAAC;QAC7C,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,IAA+F,CAAC;QACpG,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YAClC,MAAM,YAAY,GAAmC,KAAK,KAAK,CAAC;gBAC9D,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;YACzF,MAAM,GAAG,GAAG,aAAa,CACvB,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EACtI,MAAM,EACN,KAAK,EACL,YAAY,CACb,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjC,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC7C,QAAQ,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;YAC7B,IAAI,IAAI;gBAAE,IAAI,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtF,QAAQ,GAAG,iBAAiB,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM;YAAE,MAAM;QACnB,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CACtD,cAAc,CAAC,IAAI,CAAC,KAAK,CAAE,EAAE,cAAc,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CACnH,CAAC;QACF,IAAI,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,WAAW,CAAC;YAAE,MAAM;QACtE,OAAO,GAAG,WAAW,CAAC;QACtB,oEAAoE;QACpE,4DAA4D;IAC9D,CAAC;IACD,IAAI,SAAS;QAAE,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACnE,OAAO,IAAI,CAAC;AACd,CAAC"}
+{"version":3,"file":"book.js","sourceRoot":"","sources":["../../src/bundle/book.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,2EAA2E;AAC3E,0EAA0E;AAC1E,yEAAyE;AACzE,iEAAiE;AACjE,4CAA4C;AAI5C,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE3G,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAmB/D;sBACsB;AACtB,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB,MAAM,mBAAmB,GAAG,uBAAuB,CAAC;AAEpD;;;;;qDAKqD;AACrD,SAAS,gBAAgB,CAAC,QAAgB;IACxC,MAAM,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChD,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC7F,IAAI,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACzB,OAAO,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC9B,MAAM,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACvC,MAAM,OAAO,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QACjD,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC;YAC9D,MAAM,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACjD,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/E,CAAC;QACD,IAAI,EAAE,KAAK,CAAC,CAAC;YAAE,MAAM;QACrB,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;IACf,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;uBAEuB;AACvB,SAAS,gBAAgB,CAAC,GAAgB;IACxC,IAAI,KAAyB,CAAC;IAC9B,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;YAAE,KAAK,GAAG,CAAC,CAAC,SAAS,CAAC;IAC5F,CAAC;IACD,MAAM,IAAI,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChE,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,CAAC,GAAG,CAAC,eAAe,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9G,CAAC;AAED;;uCAEuC;AACvC,MAAM,UAAU,WAAW,CACzB,MAAuH,EACvH,UAA8B,EAAE;IAEhC,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC;IACpH,MAAM,MAAM,GAAG,cAAc,IAAI,MAAM,CAAC,MAAM,CAAC;IAC/C,MAAM,SAAS,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,WAAW,IAAI,sBAAsB,EAAE,CAAC;IACtD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IACjC,uEAAuE;IACvE,0DAA0D;IAC1D,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,QAAQ,GAAqB,EAAE,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAC/H,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACtG,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;IACtF,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpC,wEAAwE;IACxE,uEAAuE;IACvE,0DAA0D;IAC1D,MAAM,aAAa,GAAG,qBAAqB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAEtE,IAAI,OAAmC,CAAC;IACxC,IAAI,aAAiC,CAAC;IACtC,IAAI,IAAI,GAAkB,EAAE,CAAC;IAC7B,KAAK,IAAI,KAAK,GAAG,CAAC,GAAI,KAAK,EAAE,EAAE,CAAC;QAC9B,IAAI,GAAG,EAAE,CAAC;QACV,MAAM,aAAa,GAAuC,EAAE,CAAC;QAC7D,IAAI,QAAwC,CAAC;QAC7C,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,IAAI,IAA+F,CAAC;QACpG,MAAM,KAAK,GAAG,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;YAClC,MAAM,YAAY,GAAmC,KAAK,KAAK,CAAC;gBAC9D,CAAC,CAAC,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;gBACnD,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,KAAK,EAAE,CAAC;YACnG,MAAM,GAAG,GAAG,aAAa,CACvB,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAC9H,MAAM,EACN,KAAK,EACL,YAAY,CACb,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACf,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjC,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC7C,QAAQ,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;YAC7B,IAAI,IAAI;gBAAE,IAAI,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,eAAe,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtF,QAAQ,GAAG,iBAAiB,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;QACH,kEAAkE;QAClE,oEAAoE;QACpE,0DAA0D;QAC1D,IAAI,YAAY,GAAG,KAAK,CAAC;QACzB,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;gBACtD,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,KAAK,CAAE,EAAE,cAAc,CAAC,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBACjH,6DAA6D;gBAC7D,4DAA4D;gBAC5D,mEAAmE;gBACnE,YAAY;gBACZ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC;oBAAE,OAAO,OAAO,CAAC;gBACzF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;gBACtF,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YACvH,CAAC,CAAC,CAAC;YACH,YAAY,GAAG,CAAC,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,WAAW,CAAC,CAAC;YAC3E,oEAAoE;YACpE,4DAA4D;YAC5D,IAAI,YAAY;gBAAE,OAAO,GAAG,WAAW,CAAC;QAC1C,CAAC;QACD,MAAM,UAAU,GAAG,aAAa,IAAI,aAAa,KAAK,QAAQ,CAAC;QAC/D,IAAI,aAAa;YAAE,aAAa,GAAG,QAAQ,CAAC;QAC5C,MAAM,KAAK,GAAG,CAAC,YAAY,IAAI,KAAK,GAAG,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,IAAI,KAAK,GAAG,CAAC,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC;QACrG,IAAI,CAAC,KAAK;YAAE,MAAM;IACpB,CAAC;IACD,IAAI,SAAS;QAAE,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACnE,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/bundle/codec.d.ts

@@ -11,7 +11,34 @@ export interface ReadBundleOptions {
     /** How loaded files are named (`fileId`). Defaults to their path. */
     ids?: BundleIdScheme;
     /** Configuration under the manifest's `config`. Defaults to
-     *  `bundleBaseConfig(locale)`. */
+     *  `bundleBaseConfig()` in the language of the bundle
+     *  (`resolveBundleConfigLocale(manifest, locale)`: the locale it serves,
+     *  or the language its `config` names when the manifest names none), so
+     *  a bundle in one language gets resource types in that language,
+     *  whatever `locale` asks for. A host that passes its own base should
+     *  localise it to the same language. It is taken in today's terms, with
+     *  one exception: under a manifest older than `CONFIG_VERSION` whose
+     *  chapters set maths, a base `math` that neither the manifest nor the
+     *  locale replaces is pinned with the bundle's (`fontSizeScale` ×
+     *  `LEGACY_MATH_SIZE`, see `pinLegacyMathSize`), since 1.4 set the
+     *  bundle's formulas at that size; so is a base `layout`'s inline gap
+     *  (`pinLegacyInlineGap`) when the chapters embed a resource, and its
+     *  gap in boxes (`pinLegacyBoxResourceGap`) when they embed one inside a
+     *  `:::callout`; a base `bodyText`'s colon-list room
+     *  (`pinLegacyColonListRoom`) when they introduce a list with a colon; a
+     *  base `headings`' inline marks (`pinLegacyHeadingMarks`) when a heading
+     *  of theirs carries one; a base `layout`'s box cut
+     *  (`pinLegacyBoxChildCut`) when they hold a `:::callout`; a base
+     *  `bodyText`'s dash breaks (`pinLegacyDashBreaks`) when they set a dash
+     *  closed between words, its compound breaks (`pinLegacyHyphenBreaks`)
+     *  when they set a hyphen between two letters, and its ragged breaking
+     *  (`pinLegacyRaggedBreaking`) when the configuration sets some running
+     *  text ragged; a base `headings`' split under a heading
+     *  (`pinLegacyHeadingSplit`) when they have a heading; a base
+     *  `bodyText`'s space under `:::paragraphs` containers
+     *  (`pinLegacyParagraphContainerSpacing`) when they hold one and the
+     *  configuration declares a paragraph style; and the size of every drop
+     *  cap in the base that names none (`pinLegacyDropCapSize`). */
     baseConfig?: PostextConfig;
     /** Intrinsic size of an SVG whose spec omits it. Defaults to `svgSize`. */
     measureSvg?: (markup: string) => BundleImageSize | undefined;
@@ -28,7 +55,22 @@ export interface ReadBundleResult {
     locale: string;
     chapters: BundleChapter[];
     /** Base config + manifest `config` + the locale's overrides, with the
-     *  bundle's font families appended to `customFonts`. */
+     *  bundle's font families appended to `customFonts`. A manifest stored
+     *  under older rules than `CONFIG_VERSION` (none: postext 1.4 or earlier)
+     *  is read in today's terms (see `migrateConfig`): its heading breaks,
+     *  its maths size when its chapters set maths, the space around its
+     *  inline resources when they embed one (inside a box too, when a box
+     *  embeds one), its headings' inline marks when a heading carries one,
+     *  the size of its drop caps, the room kept for a list under a colon line
+     *  when its chapters introduce one so, the lines a box cut leaves of a
+     *  paragraph or list item when they hold a box, the line breaks after a
+     *  closed dash when they set one, the line breaks at a compound's hyphen
+     *  when they set one, the line-by-line breaking of its ragged text when
+     *  it has some, the split of a paragraph under a heading when they have
+     *  a heading, and the space under its `:::paragraphs` containers when
+     *  they hold one, are the ones 1.4 laid out. The layout
+     *  fixes of postext 1.5 that no pin holds back apply to it as to any
+     *  book. */
     config: PostextConfig;
     resources: Resource[];
     /** Resource payloads (pictures and PDF print masters). */
@@ -36,7 +78,20 @@ export interface ReadBundleResult {
     fonts: BundleFontFile[];
 }
 /** Read a manifest plus its files. Throws on an invalid manifest or a
- *  missing chapter, picture or font file. */
+ *  missing chapter, picture or font file. The configuration of a manifest
+ *  written by postext 1.4 or earlier (no `configVersion`) keeps the heading
+ *  breaks, the maths size, the space around inline resources in the text
+ *  and inside boxes, the heading marks, the drop-cap sizes, the room under
+ *  a colon line that introduces a list, the lines a box cut leaves of a
+ *  paragraph or list item, the breaks at dashes and at compounds'
+ *  hyphens, the breaking of ragged text, the split under a heading and the
+ *  space under `:::paragraphs` containers it laid out then (see
+ *  `pinLegacyHeadingBreaks`, `pinLegacyMathSize`, `pinLegacyInlineGap`,
+ *  `pinLegacyBoxResourceGap`, `pinLegacyHeadingMarks`,
+ *  `pinLegacyDropCapSize`, `pinLegacyColonListRoom`, `pinLegacyBoxChildCut`,
+ *  `pinLegacyDashBreaks`, `pinLegacyHyphenBreaks`,
+ *  `pinLegacyRaggedBreaking`, `pinLegacyHeadingSplit` and
+ *  `pinLegacyParagraphContainerSpacing`). */
 export declare function readBundle(manifest: unknown, readFile: BundleFileReader, options?: ReadBundleOptions): Promise<ReadBundleResult>;
 export interface BundleMeta {
     id: string;
@@ -44,6 +99,27 @@ export interface BundleMeta {
     description?: string;
     locale?: string;
 }
+/** What another locale of a bilingual bundle brings on top of the shared
+ *  content (see {@link BundleContent.localized}). */
+export interface BundleLocaleContent {
+    /** The locale's own chapters, in book order. Absent: it reads the
+     *  shared (primary) chapters. */
+    chapters?: readonly {
+        title: string;
+        markdown: string;
+    }[];
+    /** Top-level configuration keys for the locale, each replacing the
+     *  shared key wholesale when read; a key equal to the shared one is not
+     *  written. Fonts are shared: the families of `customFonts` join the
+     *  bundle's. */
+    config?: PostextConfig;
+    /** The locale's wording and artwork of the shared resources, merged by
+     *  id: `caption`, `note`, `altText`, `table`, and a picture of its own
+     *  (`bitmap.fileId` / `svg.fileId`, `svg.pdfFileId`) when the artwork
+     *  carries words. Other fields are shared; an id that is not among the
+     *  resources is left out with a warning. */
+    resources?: readonly (Pick<Resource, 'id'> & Partial<Resource>)[];
+}
 export interface BundleContent {
     chapters: readonly {
         title: string;
@@ -58,6 +134,12 @@ export interface BundleContent {
         fileId: string;
         mime: string;
     };
+    /** Other locales of a bilingual bundle, by locale tag (`es`, `pt-BR`);
+     *  `chapters`, `config` and `resources` are then the primary locale's
+     *  (`BundleMeta.locale`, required). Written as the manifest's `locales`,
+     *  a locale → chapters map (when any locale has chapters of its own) and
+     *  `localized`. */
+    localized?: Record<string, BundleLocaleContent>;
 }
 export interface PlannedFile {
     /** Path inside the bundle (`resources/x.png`, `fonts/y.ttf`). */
@@ -66,6 +148,8 @@ export interface PlannedFile {
     kind: 'blob' | 'font';
     /** Resource id (blob) or family name (font), for warnings. */
     owner: string;
+    /** Set on a picture only one locale reads (its own artwork). */
+    locale?: string;
 }
 export interface BundlePlan {
     manifest: BundleManifestV2;

package/dist/bundle/codec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../../src/bundle/codec.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAqBxD,OAAO,KAAK,EACV,UAAU,EACV,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAEhB,cAAc,EACd,cAAc,EACd,eAAe,EACf,cAAc,EACd,gBAAgB,EAEjB,MAAM,SAAS,CAAC;AAEjB;;qDAEqD;AACrD,wBAAgB,gBAAgB,CAAC,MAAM,SAAO,GAAG,aAAa,CAE7D;AAED,MAAM,WAAW,iBAAiB;IAChC;6BACyB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qEAAqE;IACrE,GAAG,CAAC,EAAE,cAAc,CAAC;IACrB;sCACkC;IAClC,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,2EAA2E;IAC3E,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,eAAe,GAAG,SAAS,CAAC;IAC7D;2CACuC;IACvC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,GAAG,eAAe,GAAG,SAAS,CAAC;IACzH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,cAAc,CAAC;IACzB;;sBAEkB;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B;4DACwD;IACxD,MAAM,EAAE,aAAa,CAAC;IACtB,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,0DAA0D;IAC1D,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB;AAID;6CAC6C;AAC7C,wBAAsB,UAAU,CAC9B,QAAQ,EAAE,OAAO,EACjB,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,gBAAgB,CAAC,CAyE3B;AAKD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,SAAS;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzD,MAAM,EAAE,aAAa,CAAC;IACtB,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAC;IAC/B,mEAAmE;IACnE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,gEAAgE;IAChE,SAAS,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9C;AAED,MAAM,WAAW,WAAW;IAC1B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB;+BAC2B;IAC3B,YAAY,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACnD,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAYD;oCACoC;AACpC,eAAO,MAAM,uBAAuB,kCAAmC,CAAC;AAExE;;6EAE6E;AAC7E,wBAAgB,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,GAAG,UAAU,CA6F/E;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IACnF,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;CACpF;AAED,MAAM,WAAW,mBAAmB;IAClC,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,sEAAsE;IACtE,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAMD;;;2CAG2C;AAC3C,wBAAsB,kBAAkB,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CA4CnH"}
+{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../../src/bundle/codec.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAuBxD,OAAO,KAAK,EACV,UAAU,EACV,iBAAiB,EACjB,aAAa,EAEb,gBAAgB,EAEhB,cAAc,EACd,cAAc,EACd,eAAe,EAEf,cAAc,EACd,gBAAgB,EAEjB,MAAM,SAAS,CAAC;AAEjB;;qDAEqD;AACrD,wBAAgB,gBAAgB,CAAC,MAAM,SAAO,GAAG,aAAa,CAE7D;AAED,MAAM,WAAW,iBAAiB;IAChC;6BACyB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qEAAqE;IACrE,GAAG,CAAC,EAAE,cAAc,CAAC;IACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;oEA4BgE;IAChE,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,2EAA2E;IAC3E,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,eAAe,GAAG,SAAS,CAAC;IAC7D;2CACuC;IACvC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,GAAG,eAAe,GAAG,SAAS,CAAC;IACzH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,cAAc,CAAC;IACzB;;sBAEkB;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B;;;;;;;;;;;;;;;;gBAgBY;IACZ,MAAM,EAAE,aAAa,CAAC;IACtB,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,0DAA0D;IAC1D,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB;AAID;;;;;;;;;;;;;;6CAc6C;AAC7C,wBAAsB,UAAU,CAC9B,QAAQ,EAAE,OAAO,EACjB,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,gBAAgB,CAAC,CAwF3B;AAKD,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;qDACqD;AACrD,MAAM,WAAW,mBAAmB;IAClC;qCACiC;IACjC,QAAQ,CAAC,EAAE,SAAS;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC1D;;;oBAGgB;IAChB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB;;;;gDAI4C;IAC5C,SAAS,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;CACnE;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,SAAS;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzD,MAAM,EAAE,aAAa,CAAC;IACtB,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAC;IAC/B,mEAAmE;IACnE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,gEAAgE;IAChE,SAAS,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C;;;;uBAImB;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,WAAW;IAC1B,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAC;IACd,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB;+BAC2B;IAC3B,YAAY,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACnD,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAYD;oCACoC;AACpC,eAAO,MAAM,uBAAuB,kCAAmC,CAAC;AAExE;;6EAE6E;AAC7E,wBAAgB,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,GAAG,UAAU,CA2L/E;AA+BD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;IACnF,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,GAAG,UAAU,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;CACpF;AAED,MAAM,WAAW,mBAAmB;IAClC,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,sEAAsE;IACtE,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAMD;;;2CAG2C;AAC3C,wBAAsB,kBAAkB,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAoEnH"}

package/dist/bundle/codec.js

@@ -4,7 +4,8 @@
 // resources and file payloads; `planBundle` / `resolveBundleFiles` do the
 // reverse. Nothing here touches storage.
 import { cloneDefaultColorPalette, defaultResourceTypes, stripConfigDefaults } from '../defaults';
-import { bitmapSize, chapterFileName, extensionForImageMime, extensionForResource, fontsToCustomFonts, isBitmapFile, isBundleManifest, isPdfFile, isSvgFile, mimeForFile, pickChapterSpecs, pickLocaleOverrides, resolveBundleLocale, resourceFromSpec, slugify, svgSize, uniqueSlug, } from './manifest';
+import { bitmapSize, chapterFileName, extensionForImageMime, extensionForResource, fontsToCustomFonts, isBitmapFile, isBundleManifest, isPdfFile, isSvgFile, mimeForFile, pickChapterSpecs, pickLocaleOverrides, resolveBundleConfigLocale, resolveBundleLocale, resourceFromSpec, slugify, svgSize, uniqueSlug, } from './manifest';
+import { CONFIG_VERSION, migrateBundleConfig } from './configVersion';
 /** The configuration a bundle's own `config` is laid over: the default
  *  colour palette plus the built-in resource types localised to `locale`
  *  (what the Sandbox starts every document from). */
@@ -13,11 +14,28 @@ export function bundleBaseConfig(locale = 'en') {
 }
 const identityIds = { blob: (f) => f, font: (f) => f };
 /** Read a manifest plus its files. Throws on an invalid manifest or a
- *  missing chapter, picture or font file. */
+ *  missing chapter, picture or font file. The configuration of a manifest
+ *  written by postext 1.4 or earlier (no `configVersion`) keeps the heading
+ *  breaks, the maths size, the space around inline resources in the text
+ *  and inside boxes, the heading marks, the drop-cap sizes, the room under
+ *  a colon line that introduces a list, the lines a box cut leaves of a
+ *  paragraph or list item, the breaks at dashes and at compounds'
+ *  hyphens, the breaking of ragged text, the split under a heading and the
+ *  space under `:::paragraphs` containers it laid out then (see
+ *  `pinLegacyHeadingBreaks`, `pinLegacyMathSize`, `pinLegacyInlineGap`,
+ *  `pinLegacyBoxResourceGap`, `pinLegacyHeadingMarks`,
+ *  `pinLegacyDropCapSize`, `pinLegacyColonListRoom`, `pinLegacyBoxChildCut`,
+ *  `pinLegacyDashBreaks`, `pinLegacyHyphenBreaks`,
+ *  `pinLegacyRaggedBreaking`, `pinLegacyHeadingSplit` and
+ *  `pinLegacyParagraphContainerSpacing`). */
 export async function readBundle(manifest, readFile, options = {}) {
     if (!isBundleManifest(manifest))
         throw new Error('Invalid bundle manifest (preset.json)');
     const locale = options.locale ?? manifest.locale ?? 'en';
+    // The language the content comes in: a single-language bundle serves its
+    // own whatever the reader asks for, so its default resource types
+    // ("Figura", "Tabla") follow that, not the reader's locale (EF-150).
+    const served = resolveBundleLocale(manifest, locale);
     const ids = options.ids ?? identityIds;
     const onWarning = options.onWarning;
     const measureSvg = options.measureSvg ?? svgSize;
@@ -83,10 +101,16 @@ export async function readBundle(manifest, readFile, options = {}) {
     for (const w of fontSet.warnings)
         onWarning?.(w);
     const fonts = await Promise.all(fontSet.files.map(async (f) => ({ ...f, bytes: await readFile(f.file) })));
-    const baseConfig = { ...(options.baseConfig ?? bundleBaseConfig(locale)), ...(manifest.config ?? {}), ...(overrides?.config ?? {}) };
+    // A manifest written for older rules (postext 1.4 or earlier has no
+    // `configVersion`) is read with the heading breaks, the maths size and
+    // the inline gap it laid out then. The reader's own base configuration
+    // keeps its heading breaks, but its `math` and `layout`, when no layer
+    // replaces them, are the ones 1.4 set the book with, so they are pinned
+    // with the rest.
+    const baseConfig = migrateBundleConfig(options.baseConfig ?? bundleBaseConfig(resolveBundleConfigLocale(manifest, locale)), [manifest.config ?? {}, overrides?.config ?? {}], manifest.configVersion, { content: chapters.map((c) => c.markdown) });
     const customFonts = [...(manifest.config?.customFonts ?? []), ...fontSet.families];
     const config = customFonts.length > 0 ? { ...baseConfig, customFonts } : baseConfig;
-    return { manifest, locale: resolveBundleLocale(manifest, locale), chapters, config, resources, blobs, fonts };
+    return { manifest, locale: served, chapters, config, resources, blobs, fonts };
 }
 /** A resource minus the fields that only make sense in storage. */
 function omitStorageFields(r) {
@@ -108,6 +132,19 @@ export function planBundle(meta, content) {
     const files = [];
     const takenResourceNames = new Set();
     const takenFontNames = new Set();
+    const localized = content.localized && Object.keys(content.localized).length > 0 ? content.localized : undefined;
+    if (localized) {
+        if (!meta.locale)
+            throw new Error('planBundle: `localized` needs `locale`, the language of the shared content');
+        for (const key of Object.keys(localized)) {
+            if (key.trim().length === 0 || key.toLowerCase() === meta.locale.toLowerCase()) {
+                throw new Error(`planBundle: \`localized\` names the primary locale "${key}" again`);
+            }
+        }
+    }
+    // File name (slug) of each resource with a payload, for the pictures a
+    // locale brings of its own.
+    const resourceNames = new Map();
     const resources = [];
     for (const r of content.resources) {
         const { bitmap, svg } = r;
@@ -120,6 +157,7 @@ export function planBundle(meta, content) {
         }
         const name = uniqueSlug(slugify(r.id), takenResourceNames, 'resource');
         takenResourceNames.add(name);
+        resourceNames.set(r.id, name);
         const path = `resources/${name}.${ext}`;
         files.push({ path, fileId, kind: 'blob', owner: r.id });
         let pdfFile;
@@ -137,8 +175,17 @@ export function planBundle(meta, content) {
             ...(height ? { height } : {}),
         });
     }
+    // Fonts are shared by every locale: a family only a locale's config
+    // names joins the primary ones.
+    const families = [...(content.config.customFonts ?? [])];
+    for (const entry of Object.values(localized ?? {})) {
+        for (const family of entry.config?.customFonts ?? []) {
+            if (!families.some((f) => f.name === family.name))
+                families.push(family);
+        }
+    }
     const fonts = [];
-    for (const family of content.config.customFonts ?? []) {
+    for (const family of families) {
         // A family the document may set but not pass on: its files stay behind
         // and no `fonts[]` entry names it, so the bundle opens with the
         // reader's own fallback for that family.
@@ -169,29 +216,135 @@ export function planBundle(meta, content) {
     }
     const configWithoutFonts = { ...stripConfigDefaults(content.config) };
     delete configWithoutFonts.customFonts;
-    const takenChapterNames = new Set();
-    const chapterSpecs = [];
+    // Chapter files: `chapters/01-intro.md`, or one folder per locale when
+    // any locale has chapters of its own (`chapters/es/01-intro.md`).
     const chapterFiles = [];
-    content.chapters.forEach((c, i) => {
-        const path = chapterFileName(i, c.title, takenChapterNames, content.chapters.length);
-        chapterSpecs.push({ title: c.title, file: path });
-        chapterFiles.push({ path, markdown: c.markdown });
-    });
+    const writeChapters = (chapters, folder) => {
+        const taken = new Set();
+        return chapters.map((c, i) => {
+            const name = chapterFileName(i, c.title, taken, chapters.length);
+            const path = folder ? name.replace(/^chapters\//, `chapters/${folder}/`) : name;
+            chapterFiles.push({ path, markdown: c.markdown });
+            return { title: c.title, file: path };
+        });
+    };
+    const perLocale = localized !== undefined && Object.values(localized).some((l) => l.chapters && l.chapters.length > 0);
+    let chapterSpecs;
+    if (localized && perLocale && meta.locale) {
+        const primary = writeChapters(content.chapters, localeFolder(meta.locale));
+        const map = { [meta.locale]: primary };
+        for (const [locale, entry] of Object.entries(localized)) {
+            map[locale] = entry.chapters && entry.chapters.length > 0 ? writeChapters(entry.chapters, localeFolder(locale)) : primary;
+        }
+        chapterSpecs = map;
+    }
+    else {
+        chapterSpecs = writeChapters(content.chapters);
+    }
+    // Per locale, what differs from the shared content: configuration keys,
+    // and the wording and artwork of resources.
+    const localizedSpecs = {};
+    const byId = new Map(content.resources.map((r) => [r.id, r]));
+    for (const [locale, entry] of Object.entries(localized ?? {})) {
+        const overrides = {};
+        if (entry.config) {
+            const config = localizedConfig(entry.config, configWithoutFonts);
+            if (Object.keys(config).length > 0)
+                overrides.config = config;
+        }
+        const wording = [];
+        for (const r of entry.resources ?? []) {
+            const base = byId.get(r.id);
+            if (!base) {
+                warnings.push(`${r.id}: not among the resources, its ${locale} wording left out`);
+                continue;
+            }
+            const spec = { id: r.id };
+            for (const key of LOCALIZABLE_RESOURCE_FIELDS) {
+                const value = r[key];
+                if (value !== undefined && !sameJson(value, base[key]))
+                    spec[key] = value;
+            }
+            // Artwork of its own (a picture with words in it), written in the
+            // locale's folder under the shared file's name.
+            const merged = { ...base, ...r };
+            const ext = extensionForResource(merged);
+            const fileId = r.bitmap?.fileId ?? r.svg?.fileId;
+            const pdfFileId = r.svg?.pdfFileId;
+            const ownFile = !!ext && !!fileId && fileId !== (base.bitmap?.fileId ?? base.svg?.fileId);
+            const ownMaster = !!pdfFileId && pdfFileId !== base.svg?.pdfFileId && merged.kind === 'svg';
+            let name = resourceNames.get(r.id);
+            if ((ownFile || ownMaster) && name === undefined) {
+                name = uniqueSlug(slugify(r.id), takenResourceNames, 'resource');
+                takenResourceNames.add(name);
+                resourceNames.set(r.id, name);
+            }
+            if (ownFile) {
+                spec.file = `resources/${localeFolder(locale)}/${name}.${ext}`;
+                files.push({ path: spec.file, fileId: fileId, kind: 'blob', owner: r.id, locale });
+                const width = r.bitmap?.width ?? r.svg?.width;
+                const height = r.bitmap?.height ?? r.svg?.height;
+                if (width)
+                    spec.width = width;
+                if (height)
+                    spec.height = height;
+            }
+            if (ownMaster) {
+                spec.pdfFile = `resources/${localeFolder(locale)}/${name}.pdf`;
+                files.push({ path: spec.pdfFile, fileId: pdfFileId, kind: 'blob', owner: r.id, locale });
+            }
+            if (Object.keys(spec).length > 1)
+                wording.push(spec);
+        }
+        if (wording.length > 0)
+            overrides.resources = wording;
+        localizedSpecs[locale] = overrides;
+    }
     const manifest = {
         version: 2,
+        configVersion: CONFIG_VERSION,
         id: meta.id,
         name: meta.name,
         ...(meta.description ? { description: meta.description } : {}),
         ...(meta.locale ? { locale: meta.locale } : {}),
+        ...(localized && meta.locale ? { locales: [meta.locale, ...Object.keys(localized)] } : {}),
         ...(thumbnailPath ? { thumbnail: thumbnailPath } : {}),
         ...(content.canvasScope === 'book' ? { view: { canvasScope: 'book' } } : {}),
         chapters: chapterSpecs,
         config: configWithoutFonts,
         ...(resources.length > 0 ? { resources } : {}),
         ...(fonts.length > 0 ? { fonts } : {}),
+        ...(localized ? { localized: localizedSpecs } : {}),
     };
     return { manifest, files, chapterFiles, warnings };
 }
+/** Resource fields a locale may word differently. */
+const LOCALIZABLE_RESOURCE_FIELDS = ['caption', 'note', 'altText', 'table'];
+/** Folder a locale's own files are written in (`chapters/es/…`). */
+function localeFolder(locale) {
+    return slugify(locale) || 'locale';
+}
+function sameJson(a, b) {
+    return JSON.stringify(a) === JSON.stringify(b);
+}
+/** The top-level keys of a locale's configuration that differ from the
+ *  shared (stripped) configuration, each stripped of its defaults. A key
+ *  whose value is all defaults while the shared one is not is written as
+ *  given (`layout: {}`), so that it still replaces the shared key. */
+function localizedConfig(own, shared) {
+    const stripped = stripConfigDefaults(own);
+    const raw = own;
+    const base = shared;
+    const out = {};
+    for (const key of Object.keys(raw)) {
+        if (key === 'customFonts' || raw[key] === undefined)
+            continue;
+        if (sameJson(stripped[key], base[key]))
+            continue;
+        out[key] = stripped[key] ?? raw[key];
+    }
+    return out;
+}
 function toBytes(data) {
     return data instanceof Uint8Array ? data : new Uint8Array(data);
 }
@@ -209,7 +362,7 @@ export async function resolveBundleFiles(plan, sources) {
             : await Promise.resolve(sources.readFont(f.fileId)).catch(() => null);
         if (!bytes) {
             missingPaths.add(f.path);
-            warnings.push(`${f.owner}: missing file, skipped`);
+            warnings.push(f.locale ? `${f.owner}: missing ${f.locale} file, the shared one is used` : `${f.owner}: missing file, skipped`);
             return;
         }
         files[f.path] = toBytes(bytes);
@@ -235,6 +388,33 @@ export async function resolveBundleFiles(plan, sources) {
             delete manifest.resources;
         if (!fonts || fonts.length === 0)
             delete manifest.fonts;
+        // A locale whose own artwork is missing reads the shared picture.
+        if (manifest.localized) {
+            const localized = {};
+            for (const [locale, overrides] of Object.entries(manifest.localized)) {
+                const wording = overrides.resources
+                    ?.map((r) => {
+                    const spec = { ...r };
+                    if (spec.file && missingPaths.has(spec.file)) {
+                        delete spec.file;
+                        delete spec.width;
+                        delete spec.height;
+                        delete spec.pdfFile;
+                    }
+                    if (spec.pdfFile && missingPaths.has(spec.pdfFile))
+                        delete spec.pdfFile;
+                    return spec;
+                })
+                    .filter((r) => Object.keys(r).length > 1);
+                const next = { ...overrides };
+                if (wording && wording.length > 0)
+                    next.resources = wording;
+                else
+                    delete next.resources;
+                localized[locale] = next;
+            }
+            manifest = { ...manifest, localized };
+        }
     }
     const enc = new TextEncoder();
     files['preset.json'] = enc.encode(JSON.stringify(manifest, null, 2));