postext-epub 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,205 @@
+import type { VDTDocument } from 'postext';
+/** The two values of the EPUB 3 `rendition:layout` property, as the
+ *  industry names them: a fixed layout (`pre-paginated`, FXL) reproduces
+ *  every printed page; a reflowable book (the EPUB default) reflows its text
+ *  to the reader's screen and settings. */
+export type EpubLayout = 'fixed' | 'reflowable';
+/** Book metadata written to the package document. */
+export interface EpubMetadata {
+    title: string;
+    subtitle?: string;
+    /** Authors, in order (`dc:creator`, role `aut`). */
+    creators?: string[];
+    /** BCP 47 tag of the book's language (`dc:language`, `xml:lang`). */
+    language: string;
+    /** Unique identifier: an ISBN (`urn:isbn:…` or bare digits), a URN or a
+     *  URL. When absent, a stable `urn:uuid:` is derived from the title,
+     *  creators and language, so regenerating a book keeps its identity. */
+    identifier?: string;
+    /** Publication date (`dc:date`), ISO 8601. */
+    date?: string;
+    publisher?: string;
+    rights?: string;
+    description?: string;
+    /** `dcterms:modified`; defaults to now (pass one for reproducible output). */
+    modified?: Date;
+}
+/** One font face the book embeds: every family its pages or styles use. */
+export interface EpubFontFile {
+    family: string;
+    /** A weight (`400`) or a variable range (`'100 900'`). */
+    weight: number | string;
+    style: 'normal' | 'italic';
+    bytes: Uint8Array;
+    format: 'woff2' | 'woff' | 'ttf' | 'otf';
+    /** CSS `unicode-range` of a subset file (Google Fonts slices). */
+    unicodeRange?: string;
+}
+/** Bytes of a resource picture by its `fileId` (bitmap or SVG source), with
+ *  its media type (`image/png`, `image/jpeg`, `image/webp`, `image/gif`,
+ *  `image/svg+xml`). Undefined when the host has none. */
+export type EpubResourceBytes = (fileId: string) => {
+    bytes: Uint8Array;
+    mediaType: string;
+} | undefined | Promise<{
+    bytes: Uint8Array;
+    mediaType: string;
+} | undefined>;
+export interface EpubCover {
+    bytes: Uint8Array;
+    mediaType: 'image/jpeg' | 'image/png' | 'image/webp' | 'image/svg+xml';
+    /** Text alternative of the cover picture; defaults to the title. */
+    alt?: string;
+    /** The picture shows the book's first printed page (a capture of it).
+     *  The fixed layout then gives it no page of its own, which would show
+     *  the cover twice: it is only the package's cover image (the reading
+     *  system's thumbnail) and the first page is the cover document. The
+     *  reflowable book, which has no printed pages, opens with it all the
+     *  same. */
+    showsFirstPage?: boolean;
+}
+export interface EpubProgress {
+    /** `documents`: content documents being written (pages for the fixed
+     *  layout, chapters when reflowable); `resources`: fonts and pictures;
+     *  `package`: OPF, navigation and the zip. */
+    phase: 'documents' | 'resources' | 'package';
+    done: number;
+    total: number;
+}
+export type EpubWarning = 
+/** A picture the host gave no bytes for: set as a placeholder. */
+{
+    kind: 'missingImage';
+    fileId: string;
+    resourceId?: string;
+}
+/** A family the documents use with no embedded face: readers fall back. */
+ | {
+    kind: 'missingFont';
+    family: string;
+    weight?: number | string;
+    style?: string;
+}
+/** Something the rendition could not express (named in `detail`). */
+ | {
+    kind: 'unsupported';
+    detail: string;
+};
+export interface RenderToEpubOptions {
+    layout: EpubLayout;
+    metadata: EpubMetadata;
+    fonts?: EpubFontFile[];
+    resourceBytes?: EpubResourceBytes;
+    /** The cover picture. Without one, the fixed layout uses the book's first
+     *  page as its cover document and the reflowable book has no cover image. */
+    cover?: EpubCover;
+    onProgress?: (progress: EpubProgress) => void;
+    onWarning?: (warning: EpubWarning) => void;
+    signal?: AbortSignal;
+}
+/** The input both renditions read. */
+export type EpubSource = readonly VDTDocument[];
+export interface EpubItem {
+    /** Manifest id (an XML NCName). */
+    id: string;
+    href: string;
+    mediaType: string;
+    data: Uint8Array | string;
+    /** Manifest properties (`nav`, `cover-image`, `svg`, `mathml`,
+     *  `remote-resources`…). */
+    properties?: string[];
+}
+export interface EpubSpineEntry {
+    idref: string;
+    linear?: boolean;
+    /** Spine itemref properties (`page-spread-left`, `page-spread-right`,
+     *  `rendition:page-spread-center`, `rendition:layout-pre-paginated`…). */
+    properties?: string[];
+}
+export interface EpubNavPoint {
+    label: string;
+    href: string;
+    children?: EpubNavPoint[];
+}
+/** One printed page in the `page-list` navigation. */
+export interface EpubPageTarget {
+    label: string;
+    href: string;
+}
+export interface EpubLandmark {
+    /** `epub:type` value: `cover`, `titlepage`, `toc`, `frontmatter`,
+     *  `bodymatter`, `backmatter`, `index`, `bibliography`… */
+    type: string;
+    label: string;
+    href: string;
+}
+/** Accessibility metadata (EPUB Accessibility 1.1, schema.org terms). */
+export interface EpubAccessibility {
+    accessModes: string[];
+    accessModesSufficient: string[];
+    features: string[];
+    hazards: string[];
+    summary: string;
+    /** `dcterms:conformsTo`, e.g. `EPUB Accessibility 1.1 - WCAG 2.2 Level AA`;
+     *  omitted when the book makes no claim. */
+    conformsTo?: string;
+}
+export interface EpubPublication {
+    layout: EpubLayout;
+    metadata: EpubMetadata;
+    items: EpubItem[];
+    spine: EpubSpineEntry[];
+    toc: EpubNavPoint[];
+    pageList: EpubPageTarget[];
+    landmarks: EpubLandmark[];
+    pageProgression: 'ltr' | 'rtl';
+    /** Fixed-layout rendition properties. */
+    fixed?: {
+        spread: 'none' | 'landscape' | 'both' | 'auto';
+        orientation?: 'auto' | 'portrait' | 'landscape';
+        /** Page size in CSS px, for readers that look at it. */
+        viewport: {
+            width: number;
+            height: number;
+        };
+    };
+    accessibility: EpubAccessibility;
+}
+export interface ReadEpubResult {
+    layout: EpubLayout;
+    metadata: {
+        title: string;
+        language: string;
+        identifier: string;
+        creators: string[];
+    };
+    pageProgression: 'ltr' | 'rtl';
+    /** Every file by its zip path. */
+    files: Map<string, Uint8Array>;
+    /** Directory of the package document inside the zip (`OEBPS/`). */
+    root: string;
+    /** Manifest by id: zip path and media type. */
+    manifest: Map<string, {
+        path: string;
+        mediaType: string;
+        properties: string[];
+    }>;
+    /** Spine in reading order: zip path and itemref properties. */
+    spine: {
+        id: string;
+        path: string;
+        linear: boolean;
+        properties: string[];
+    }[];
+    /** Table of contents from the nav document (`path#fragment` targets). */
+    toc: EpubNavPoint[];
+    pageList: EpubPageTarget[];
+    /** Fixed layout page size (from the OPF/first page viewport). */
+    viewport?: {
+        width: number;
+        height: number;
+    };
+    /** Path of the cover picture, if any. */
+    coverPath?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C;;;2CAG2C;AAC3C,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,YAAY,CAAC;AAEhD,qDAAqD;AACrD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IACjB;;4EAEwE;IACxE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,IAAI,CAAC;CACjB;AAED,2EAA2E;AAC3E,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC3B,KAAK,EAAE,UAAU,CAAC;IAClB,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,CAAC;IACzC,kEAAkE;IAClE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;0DAE0D;AAC1D,MAAM,MAAM,iBAAiB,GAAG,CAC9B,MAAM,EAAE,MAAM,KACX;IAAE,KAAK,EAAE,UAAU,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,GAAG,OAAO,CAAC;IAAE,KAAK,EAAE,UAAU,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,CAAC;AAE1H,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,UAAU,CAAC;IAClB,SAAS,EAAE,YAAY,GAAG,WAAW,GAAG,YAAY,GAAG,eAAe,CAAC;IACvE,oEAAoE;IACpE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;gBAKY;IACZ,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B;;kDAE8C;IAC9C,KAAK,EAAE,WAAW,GAAG,WAAW,GAAG,SAAS,CAAC;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,WAAW;AACrB,kEAAkE;AAChE;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE;AAC/D,2EAA2E;GACzE;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE;AACnF,qEAAqE;GACnE;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5C,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC;iFAC6E;IAC7E,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,IAAI,CAAC;IAC9C,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAC;IAC3C,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,sCAAsC;AACtC,MAAM,MAAM,UAAU,GAAG,SAAS,WAAW,EAAE,CAAC;AAOhD,MAAM,WAAW,QAAQ;IACvB,mCAAmC;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAC1B;gCAC4B;IAC5B,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;8EAC0E;IAC1E,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC3B;AAED,sDAAsD;AACtD,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B;+DAC2D;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,yEAAyE;AACzE,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB;gDAC4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,GAAG,EAAE,YAAY,EAAE,CAAC;IACpB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,SAAS,EAAE,YAAY,EAAE,CAAC;IAC1B,eAAe,EAAE,KAAK,GAAG,KAAK,CAAC;IAC/B,yCAAyC;IACzC,KAAK,CAAC,EAAE;QACN,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC;QAC/C,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,CAAC;QAChD,wDAAwD;QACxD,QAAQ,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC;KAC7C,CAAC;IACF,aAAa,EAAE,iBAAiB,CAAC;CAClC;AAMD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IACtF,eAAe,EAAE,KAAK,GAAG,KAAK,CAAC;IAC/B,kCAAkC;IAClC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC/B,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IACjF,+DAA+D;IAC/D,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,CAAC;IAC7E,yEAAyE;IACzE,GAAG,EAAE,YAAY,EAAE,CAAC;IACpB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,iEAAiE;IACjE,QAAQ,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types.js

@@ -0,0 +1,15 @@
+// The public contract of postext-epub and the publication model shared by
+// the two renditions and the package writer.
+//
+//   renderToEpub(docs, options)          public entry (index.ts)
+//     ├─ buildFixedPublication(...)      fixed/      one XHTML per printed page
+//     ├─ buildReflowablePublication(...) reflowable/ one XHTML per chapter
+//     └─ packEpub(publication)           package/    OCF zip, OPF, nav, NCX
+//   readEpub(bytes)                      package/    what a viewer needs
+//
+// Both renditions read the same input: the book's laid-out print documents,
+// one VDTDocument per chapter in book order (the chain the PDF backend
+// renders), so numbering, footnotes, citations, cross-references, the TOC and
+// the index arrive resolved.
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,6CAA6C;AAC7C,EAAE;AACF,iEAAiE;AACjE,gFAAgF;AAChF,2EAA2E;AAC3E,4EAA4E;AAC5E,yEAAyE;AACzE,EAAE;AACF,4EAA4E;AAC5E,uEAAuE;AACvE,8EAA8E;AAC9E,6BAA6B"}

package/dist/worker/client.d.ts

@@ -0,0 +1,39 @@
+import type { EpubResourceBytes, EpubSource, RenderToEpubOptions } from '../types';
+import type { EpubResourcePayload } from './protocol';
+export type { EpubResourcePayload } from './protocol';
+export type { EpubProgress, EpubWarning, EpubLayout, EpubMetadata, EpubFontFile, EpubCover } from '../types';
+export interface EpubWorkerRenderOptions extends Omit<RenderToEpubOptions, 'resourceBytes'> {
+    /** Picture bytes: a map by `fileId`, or the provider `renderToEpub`
+     *  takes, asked on this thread for every picture the pages place before
+     *  the worker starts (the worker cannot reach the host's stores). */
+    resourceBytes?: EpubResourceBytes | ReadonlyMap<string, EpubResourcePayload>;
+}
+export interface EpubWorkerHandle {
+    /** Write the book on the worker. The buffers of the fonts, the pictures
+     *  and the cover are transferred, not copied: the caller's views of them
+     *  are empty afterwards, so pass copies of bytes it keeps. Aborting the
+     *  signal rejects at once with an `AbortError` and stops the worker. */
+    render(docs: EpubSource, options: EpubWorkerRenderOptions): Promise<Uint8Array>;
+    dispose(): void;
+}
+export interface CreateEpubWorkerOptions {
+    /** A worker of the caller's own (build tooling that controls the worker
+     *  URL), or a function that makes one. With a function, an aborted render
+     *  ends the worker at once and the next render starts a fresh one; a
+     *  given worker is only asked to stop. */
+    worker?: Worker | (() => Worker);
+}
+/** A failure of the worker itself (it could not load or it crashed), as
+ *  opposed to an error of the render: the caller may write the book on
+ *  its own thread instead. */
+export declare class EpubWorkerError extends Error {
+    name: string;
+}
+/** The pictures' bytes as the worker receives them: every `fileId` the
+ *  pages place, asked of the provider once (a map is taken as it is). */
+export declare function gatherResourceBytes(docs: EpubSource, source: EpubWorkerRenderOptions['resourceBytes']): Promise<[string, EpubResourcePayload][]>;
+/** The buffers to transfer with a request: those of the fonts, the
+ *  pictures and the cover, each once. */
+export declare function transferablesOf(options: Pick<EpubWorkerRenderOptions, 'fonts' | 'cover'>, resources: readonly [string, EpubResourcePayload][]): ArrayBuffer[];
+export declare function createEpubWorker(options?: CreateEpubWorkerOptions): EpubWorkerHandle;
+//# sourceMappingURL=client.d.ts.map

package/dist/worker/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/worker/client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACnF,OAAO,KAAK,EAAsB,mBAAmB,EAAuB,MAAM,YAAY,CAAC;AAE/F,YAAY,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAE7G,MAAM,WAAW,uBAAwB,SAAQ,IAAI,CAAC,mBAAmB,EAAE,eAAe,CAAC;IACzF;;yEAEqE;IACrE,aAAa,CAAC,EAAE,iBAAiB,GAAG,WAAW,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CAC9E;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;4EAGwE;IACxE,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAChF,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;8CAG0C;IAC1C,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;CAClC;AAED;;8BAE8B;AAC9B,qBAAa,eAAgB,SAAQ,KAAK;IAC/B,IAAI,SAAqB;CACnC;AAYD;yEACyE;AACzE,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,uBAAuB,CAAC,eAAe,CAAC,GAC/C,OAAO,CAAC,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAAE,CAAC,CAM1C;AAED;yCACyC;AACzC,wBAAgB,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,uBAAuB,EAAE,OAAO,GAAG,OAAO,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAAE,GAAG,WAAW,EAAE,CAS7J;AAID,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,gBAAgB,CAqIpF"}

package/dist/worker/client.js

@@ -0,0 +1,184 @@
+// Write EPUB files on a worker: `createEpubWorker().render(docs, options)`
+// takes what `renderToEpub` takes and returns the same bytes, with the
+// page itself left free while the book is written.
+import { placedFileIds } from '../shared/assets';
+/** A failure of the worker itself (it could not load or it crashed), as
+ *  opposed to an error of the render: the caller may write the book on
+ *  its own thread instead. */
+export class EpubWorkerError extends Error {
+    name = 'EpubWorkerError';
+}
+const abortError = (signal) => signal?.reason ?? new DOMException('The EPUB render was aborted', 'AbortError');
+/** The pictures' bytes as the worker receives them: every `fileId` the
+ *  pages place, asked of the provider once (a map is taken as it is). */
+export async function gatherResourceBytes(docs, source) {
+    if (!source)
+        return [];
+    if (typeof source !== 'function')
+        return [...source];
+    const fileIds = [...new Set(docs.flatMap(placedFileIds))];
+    const found = await Promise.all(fileIds.map(async (fileId) => [fileId, await source(fileId)]));
+    return found.filter((entry) => entry[1] !== undefined);
+}
+/** The buffers to transfer with a request: those of the fonts, the
+ *  pictures and the cover, each once. */
+export function transferablesOf(options, resources) {
+    const buffers = new Set();
+    const add = (bytes) => {
+        if (bytes && bytes.buffer instanceof ArrayBuffer && bytes.buffer.byteLength > 0)
+            buffers.add(bytes.buffer);
+    };
+    for (const font of options.fonts ?? [])
+        add(font.bytes);
+    for (const [, payload] of resources)
+        add(payload.bytes);
+    add(options.cover?.bytes);
+    return [...buffers];
+}
+const defaultWorker = () => new Worker(new URL('./epub.worker.js', import.meta.url), { type: 'module' });
+export function createEpubWorker(options) {
+    const given = options?.worker;
+    const make = typeof given === 'function' ? given : given ? null : defaultWorker;
+    let worker = null;
+    let nextId = 1;
+    let disposed = false;
+    const pending = new Map();
+    const settle = (id) => {
+        const entry = pending.get(id);
+        pending.delete(id);
+        return entry;
+    };
+    const listen = (w) => {
+        w.addEventListener('message', (event) => {
+            const msg = event.data;
+            switch (msg.kind) {
+                case 'progress':
+                    pending.get(msg.id)?.options.onProgress?.(msg.progress);
+                    return;
+                case 'warning':
+                    pending.get(msg.id)?.options.onWarning?.(msg.warning);
+                    return;
+                case 'rendered':
+                    settle(msg.id)?.resolve(msg.bytes);
+                    return;
+                case 'error': {
+                    const entry = settle(msg.id);
+                    if (!entry)
+                        return;
+                    if (msg.aborted)
+                        entry.reject(abortError(entry.options.signal));
+                    else
+                        entry.reject(Object.assign(new Error(msg.message), msg.stack ? { stack: msg.stack } : {}));
+                    return;
+                }
+            }
+        });
+        w.addEventListener('error', (event) => {
+            // A script that fails to load or throws at the top level.
+            event.preventDefault();
+            fail(w, new EpubWorkerError(event.message || 'EPUB worker error'));
+        });
+        w.addEventListener('messageerror', () => fail(w, new EpubWorkerError('EPUB worker could not read a message')));
+    };
+    /** Reject every render on `w` and let the next render start afresh. */
+    const fail = (w, err) => {
+        for (const [id, entry] of pending) {
+            if (entry.worker !== w)
+                continue;
+            pending.delete(id);
+            entry.reject(err);
+        }
+        if (worker === w && make) {
+            w.terminate();
+            worker = null;
+        }
+    };
+    const current = () => {
+        if (disposed)
+            throw new Error('EPUB worker has been disposed');
+        if (!worker) {
+            try {
+                worker = make();
+            }
+            catch (err) {
+                // No module workers here, or a policy forbids the script.
+                throw new EpubWorkerError(err instanceof Error ? err.message : String(err));
+            }
+            listen(worker);
+        }
+        return worker;
+    };
+    if (typeof given === 'object') {
+        worker = given;
+        listen(given);
+    }
+    return {
+        async render(input, renderOptions) {
+            const docs = [...input];
+            const { signal } = renderOptions;
+            signal?.throwIfAborted();
+            const resourceBytes = await gatherResourceBytes(docs, renderOptions.resourceBytes);
+            signal?.throwIfAborted();
+            const w = current();
+            const id = nextId++;
+            return new Promise((resolve, reject) => {
+                const entry = { resolve, reject, options: renderOptions, worker: w };
+                pending.set(id, entry);
+                const onAbort = () => {
+                    if (!pending.has(id))
+                        return;
+                    pending.delete(id);
+                    reject(abortError(signal));
+                    try {
+                        w.postMessage({ kind: 'cancel', id });
+                    }
+                    catch { /* ended */ }
+                    // The writer checks its signal between steps, which a long
+                    // synchronous stretch delays: a worker of our own is ended now,
+                    // unless another render is using it.
+                    if (make && worker === w && ![...pending.values()].some((p) => p.worker === w)) {
+                        w.terminate();
+                        worker = null;
+                    }
+                };
+                signal?.addEventListener('abort', onAbort, { once: true });
+                const done = () => signal?.removeEventListener('abort', onAbort);
+                entry.resolve = (bytes) => { done(); resolve(bytes); };
+                entry.reject = (err) => { done(); reject(err); };
+                const { layout, metadata, fonts, cover } = renderOptions;
+                const message = {
+                    kind: 'render',
+                    id,
+                    docs,
+                    settings: { layout, metadata, ...(fonts ? { fonts } : {}), ...(cover ? { cover } : {}) },
+                    resourceBytes,
+                };
+                try {
+                    w.postMessage(message, transferablesOf(renderOptions, resourceBytes));
+                }
+                catch (err) {
+                    pending.delete(id);
+                    entry.reject(err);
+                }
+            });
+        },
+        dispose() {
+            if (disposed)
+                return;
+            disposed = true;
+            const w = worker;
+            worker = null;
+            if (w) {
+                try {
+                    w.postMessage({ kind: 'dispose' });
+                }
+                catch { /* ended */ }
+                w.terminate();
+            }
+            for (const entry of pending.values())
+                entry.reject(new DOMException('Worker disposed', 'AbortError'));
+            pending.clear();
+        },
+    };
+}
+//# sourceMappingURL=client.js.map

package/dist/worker/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/worker/client.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,uEAAuE;AACvE,mDAAmD;AAGnD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AA+BjD;;8BAE8B;AAC9B,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAC/B,IAAI,GAAG,iBAAiB,CAAC;CACnC;AASD,MAAM,UAAU,GAAG,CAAC,MAA+B,EAAW,EAAE,CAC9D,MAAM,EAAE,MAAM,IAAI,IAAI,YAAY,CAAC,6BAA6B,EAAE,YAAY,CAAC,CAAC;AAElF;yEACyE;AACzE,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,IAAgB,EAChB,MAAgD;IAEhD,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,IAAI,OAAO,MAAM,KAAK,UAAU;QAAE,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAC1D,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC,MAAM,CAAC,CAAU,CAAC,CAAC,CAAC;IACxG,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAA0C,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;AACjG,CAAC;AAED;yCACyC;AACzC,MAAM,UAAU,eAAe,CAAC,OAAyD,EAAE,SAAmD;IAC5I,MAAM,OAAO,GAAG,IAAI,GAAG,EAAe,CAAC;IACvC,MAAM,GAAG,GAAG,CAAC,KAA6B,EAAE,EAAE;QAC5C,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,YAAY,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC,UAAU,GAAG,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7G,CAAC,CAAC;IACF,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,IAAI,EAAE;QAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxD,KAAK,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,SAAS;QAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxD,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC1B,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;AACtB,CAAC;AAED,MAAM,aAAa,GAAG,GAAW,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AAEjH,MAAM,UAAU,gBAAgB,CAAC,OAAiC;IAChE,MAAM,KAAK,GAAG,OAAO,EAAE,MAAM,CAAC;IAC9B,MAAM,IAAI,GAAG,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC;IAChF,IAAI,MAAM,GAAkB,IAAI,CAAC;IACjC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAmB,CAAC;IAE3C,MAAM,MAAM,GAAG,CAAC,EAAU,EAAuB,EAAE;QACjD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC9B,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACnB,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,CAAC,CAAS,EAAQ,EAAE;QACjC,CAAC,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAwC,EAAE,EAAE;YACzE,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC;YACvB,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;gBACjB,KAAK,UAAU;oBACb,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBACxD,OAAO;gBACT,KAAK,SAAS;oBACZ,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBACtD,OAAO;gBACT,KAAK,UAAU;oBACb,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;oBACnC,OAAO;gBACT,KAAK,OAAO,CAAC,CAAC,CAAC;oBACb,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC7B,IAAI,CAAC,KAAK;wBAAE,OAAO;oBACnB,IAAI,GAAG,CAAC,OAAO;wBAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;;wBAC3D,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBAChG,OAAO;gBACT,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACpC,0DAA0D;YAC1D,KAAK,CAAC,cAAc,EAAE,CAAC;YACvB,IAAI,CAAC,CAAC,EAAE,IAAI,eAAe,CAAC,KAAK,CAAC,OAAO,IAAI,mBAAmB,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,gBAAgB,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,eAAe,CAAC,sCAAsC,CAAC,CAAC,CAAC,CAAC;IACjH,CAAC,CAAC;IAEF,uEAAuE;IACvE,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,GAAY,EAAQ,EAAE;QAC7C,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;YAClC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YACjC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACnB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,CAAC;QACD,IAAI,MAAM,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;YACzB,CAAC,CAAC,SAAS,EAAE,CAAC;YACd,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,GAAW,EAAE;QAC3B,IAAI,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC;gBACH,MAAM,GAAG,IAAK,EAAE,CAAC;YACnB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,0DAA0D;gBAC1D,MAAM,IAAI,eAAe,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9E,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,CAAC;QACjB,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IACF,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,GAAG,KAAK,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC;IAED,OAAO;QACL,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa;YAC/B,MAAM,IAAI,GAAkB,CAAC,GAAG,KAAK,CAAC,CAAC;YACvC,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;YACjC,MAAM,EAAE,cAAc,EAAE,CAAC;YACzB,MAAM,aAAa,GAAG,MAAM,mBAAmB,CAAC,IAAI,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;YACnF,MAAM,EAAE,cAAc,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,OAAO,EAAE,CAAC;YACpB,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;YACpB,OAAO,IAAI,OAAO,CAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACjD,MAAM,KAAK,GAAY,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;gBAC9E,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;gBACvB,MAAM,OAAO,GAAG,GAAG,EAAE;oBACnB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;wBAAE,OAAO;oBAC7B,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBACnB,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;oBAC3B,IAAI,CAAC;wBAAC,CAAC,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAA+B,CAAC,CAAC;oBAAC,CAAC;oBAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC;oBACjG,2DAA2D;oBAC3D,gEAAgE;oBAChE,qCAAqC;oBACrC,IAAI,IAAI,IAAI,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;wBAC/E,CAAC,CAAC,SAAS,EAAE,CAAC;wBACd,MAAM,GAAG,IAAI,CAAC;oBAChB,CAAC;gBACH,CAAC,CAAC;gBACF,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC3D,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBACjE,KAAK,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvD,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACjD,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,aAAa,CAAC;gBACzD,MAAM,OAAO,GAAuB;oBAClC,IAAI,EAAE,QAAQ;oBACd,EAAE;oBACF,IAAI;oBACJ,QAAQ,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;oBACxF,aAAa;iBACd,CAAC;gBACF,IAAI,CAAC;oBACH,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,eAAe,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC;gBACxE,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBACnB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACpB,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAO;YACL,IAAI,QAAQ;gBAAE,OAAO;YACrB,QAAQ,GAAG,IAAI,CAAC;YAChB,MAAM,CAAC,GAAG,MAAM,CAAC;YACjB,MAAM,GAAG,IAAI,CAAC;YACd,IAAI,CAAC,EAAE,CAAC;gBACN,IAAI,CAAC;oBAAC,CAAC,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,SAAS,EAA+B,CAAC,CAAC;gBAAC,CAAC;gBAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC;gBAC9F,CAAC,CAAC,SAAS,EAAE,CAAC;YAChB,CAAC;YACD,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE;gBAAE,KAAK,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC,CAAC;YACtG,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/worker/epub.worker.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=epub.worker.d.ts.map

package/dist/worker/epub.worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"epub.worker.d.ts","sourceRoot":"","sources":["../../src/worker/epub.worker.ts"],"names":[],"mappings":""}

package/dist/worker/epub.worker.js

@@ -0,0 +1,7 @@
+/// <reference lib="webworker" />
+// The worker entry of `createEpubWorker` (`postext-epub/worker/entry`).
+// Bundlers that resolve `new Worker(new URL(…, import.meta.url))` pick it up
+// from the client; hosts that build their own worker import this module.
+import { serveEpubRequests } from './serve';
+serveEpubRequests(self);
+//# sourceMappingURL=epub.worker.js.map

package/dist/worker/epub.worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"epub.worker.js","sourceRoot":"","sources":["../../src/worker/epub.worker.ts"],"names":[],"mappings":"AAAA,iCAAiC;AAEjC,wEAAwE;AACxE,6EAA6E;AAC7E,yEAAyE;AAEzE,OAAO,EAAE,iBAAiB,EAAuB,MAAM,SAAS,CAAC;AAEjE,iBAAiB,CAAC,IAAiC,CAAC,CAAC"}

package/dist/worker/protocol.d.ts

@@ -0,0 +1,44 @@
+import type { VDTDocument } from 'postext';
+import type { EpubProgress, EpubWarning, RenderToEpubOptions } from '../types';
+/** A picture's bytes and media type, as `EpubResourceBytes` answers. */
+export interface EpubResourcePayload {
+    bytes: Uint8Array;
+    mediaType: string;
+}
+/** The render options that travel to the worker as data. */
+export type EpubRenderSettings = Pick<RenderToEpubOptions, 'layout' | 'metadata' | 'fonts' | 'cover'>;
+export type EpubRequestMessage = {
+    kind: 'render';
+    id: number;
+    docs: VDTDocument[];
+    settings: EpubRenderSettings;
+    /** Picture bytes by file id, gathered by the host beforehand. */
+    resourceBytes: [string, EpubResourcePayload][];
+}
+/** Stop the render `id`: the writer throws at its next check. */
+ | {
+    kind: 'cancel';
+    id: number;
+} | {
+    kind: 'dispose';
+};
+export type EpubResponseMessage = {
+    kind: 'progress';
+    id: number;
+    progress: EpubProgress;
+} | {
+    kind: 'warning';
+    id: number;
+    warning: EpubWarning;
+} | {
+    kind: 'rendered';
+    id: number;
+    bytes: Uint8Array;
+} | {
+    kind: 'error';
+    id: number;
+    message: string;
+    stack?: string;
+    aborted?: boolean;
+};
+//# sourceMappingURL=protocol.d.ts.map

package/dist/worker/protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/worker/protocol.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAE/E,wEAAwE;AACxE,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,UAAU,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,4DAA4D;AAC5D,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC;AAEtG,MAAM,MAAM,kBAAkB,GAC1B;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,WAAW,EAAE,CAAC;IACpB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,iEAAiE;IACjE,aAAa,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAAE,CAAC;CAChD;AACH,iEAAiE;GAC/D;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,CAAC;AAExB,MAAM,MAAM,mBAAmB,GAC3B;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,YAAY,CAAA;CAAE,GACxD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,WAAW,CAAA;CAAE,GACrD;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,UAAU,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC"}

package/dist/worker/protocol.js

@@ -0,0 +1,6 @@
+// Messages between `createEpubWorker` (client.ts) and the worker
+// (epub.worker.ts, serve.ts). Everything travels as data: the documents are
+// cloned, the bytes of fonts, pictures and the cover are transferred, and
+// the finished file comes back transferred.
+export {};
+//# sourceMappingURL=protocol.js.map

package/dist/worker/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/worker/protocol.ts"],"names":[],"mappings":"AAAA,iEAAiE;AACjE,4EAA4E;AAC5E,0EAA0E;AAC1E,4CAA4C"}

package/dist/worker/serve.d.ts

@@ -0,0 +1,11 @@
+import type { EpubRequestMessage, EpubResponseMessage } from './protocol';
+/** What the worker needs of its scope. */
+export interface EpubWorkerPort {
+    postMessage(message: EpubResponseMessage, transfer: Transferable[]): void;
+    addEventListener(type: 'message', listener: (event: MessageEvent<EpubRequestMessage>) => void): void;
+    close(): void;
+}
+/** Write the books asked for on `port`, one `renderToEpub` per request,
+ *  with progress and warnings posted as they happen. */
+export declare function serveEpubRequests(port: EpubWorkerPort): void;
+//# sourceMappingURL=serve.d.ts.map

package/dist/worker/serve.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve.d.ts","sourceRoot":"","sources":["../../src/worker/serve.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAE1E,0CAA0C;AAC1C,MAAM,WAAW,cAAc;IAC7B,WAAW,CAAC,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IAC1E,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,kBAAkB,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IACrG,KAAK,IAAI,IAAI,CAAC;CACf;AAED;wDACwD;AACxD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CA4C5D"}

package/dist/worker/serve.js

@@ -0,0 +1,53 @@
+// The worker side of `createEpubWorker`: answers render requests on a
+// message port (the worker's global scope, or a MessagePort in tests).
+import { renderToEpub } from '../index';
+/** Write the books asked for on `port`, one `renderToEpub` per request,
+ *  with progress and warnings posted as they happen. */
+export function serveEpubRequests(port) {
+    const running = new Map();
+    const post = (msg, transfer = []) => port.postMessage(msg, transfer);
+    port.addEventListener('message', async (event) => {
+        const msg = event.data;
+        switch (msg.kind) {
+            case 'render': {
+                const controller = new AbortController();
+                running.set(msg.id, controller);
+                const bytesById = new Map(msg.resourceBytes);
+                try {
+                    const bytes = await renderToEpub(msg.docs, {
+                        ...msg.settings,
+                        resourceBytes: (fileId) => bytesById.get(fileId),
+                        onProgress: (progress) => post({ kind: 'progress', id: msg.id, progress }),
+                        onWarning: (warning) => post({ kind: 'warning', id: msg.id, warning }),
+                        signal: controller.signal,
+                    });
+                    post({ kind: 'rendered', id: msg.id, bytes }, [bytes.buffer]);
+                }
+                catch (err) {
+                    post({
+                        kind: 'error',
+                        id: msg.id,
+                        message: err instanceof Error ? err.message : String(err),
+                        ...(err instanceof Error && err.stack ? { stack: err.stack } : {}),
+                        ...(controller.signal.aborted ? { aborted: true } : {}),
+                    });
+                }
+                finally {
+                    running.delete(msg.id);
+                }
+                return;
+            }
+            case 'cancel': {
+                running.get(msg.id)?.abort();
+                return;
+            }
+            case 'dispose': {
+                for (const controller of running.values())
+                    controller.abort();
+                port.close();
+                return;
+            }
+        }
+    });
+}
+//# sourceMappingURL=serve.js.map

package/dist/worker/serve.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve.js","sourceRoot":"","sources":["../../src/worker/serve.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,uEAAuE;AAEvE,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAUxC;wDACwD;AACxD,MAAM,UAAU,iBAAiB,CAAC,IAAoB;IACpD,MAAM,OAAO,GAAG,IAAI,GAAG,EAA2B,CAAC;IACnD,MAAM,IAAI,GAAG,CAAC,GAAwB,EAAE,WAA2B,EAAE,EAAQ,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAEhH,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;QAC/C,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;gBACzC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;gBAChC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBAC7C,IAAI,CAAC;oBACH,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE;wBACzC,GAAG,GAAG,CAAC,QAAQ;wBACf,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC;wBAChD,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC;wBAC1E,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC;wBACtE,MAAM,EAAE,UAAU,CAAC,MAAM;qBAC1B,CAAC,CAAC;oBACH,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;gBAChE,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC;wBACH,IAAI,EAAE,OAAO;wBACb,EAAE,EAAE,GAAG,CAAC,EAAE;wBACV,OAAO,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;wBACzD,GAAG,CAAC,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;wBAClE,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;qBACxD,CAAC,CAAC;gBACL,CAAC;wBAAS,CAAC;oBACT,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACzB,CAAC;gBACD,OAAO;YACT,CAAC;YACD,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC;gBAC7B,OAAO;YACT,CAAC;YACD,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,MAAM,EAAE;oBAAE,UAAU,CAAC,KAAK,EAAE,CAAC;gBAC9D,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,OAAO;YACT,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/worker/worker.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=worker.test.d.ts.map

package/dist/worker/worker.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.test.d.ts","sourceRoot":"","sources":["../../src/worker/worker.test.ts"],"names":[],"mappings":""}