@bendyline/squisq-formats 1.1.1 → 1.2.1

package/dist/epub/export.d.ts

@@ -0,0 +1,72 @@
+/**
+ * EPUB 3 Export
+ *
+ * Converts a MarkdownDocument (or Doc) to an EPUB 3 file (.epub).
+ *
+ * An EPUB is a ZIP archive containing XHTML chapter files, images,
+ * a package manifest (content.opf), and a navigation document (toc.xhtml).
+ * Content is split into chapters at H1/H2 heading boundaries.
+ *
+ * Uses JSZip for packaging (already a dependency), escapeXml from the
+ * OOXML utils, and image utilities from the HTML exporter.
+ *
+ * @example
+ * ```ts
+ * import { markdownDocToEpub } from '@bendyline/squisq-formats/epub';
+ *
+ * const epub = await markdownDocToEpub(markdownDoc, {
+ *   title: 'My Book',
+ *   author: 'Jane Doe',
+ * });
+ * ```
+ */
+import type { Doc, AudioSegment } from '@bendyline/squisq/schemas';
+import type { MarkdownDocument } from '@bendyline/squisq/markdown';
+export interface EpubExportOptions {
+    /** Book title (default: 'Untitled') */
+    title?: string;
+    /** Author name */
+    author?: string;
+    /** Book description / summary */
+    description?: string;
+    /** BCP-47 language code (default: 'en') */
+    language?: string;
+    /** Publisher name */
+    publisher?: string;
+    /** Squisq theme ID for CSS styling */
+    themeId?: string;
+    /** Pre-resolved image data keyed by relative path as it appears in the markdown */
+    images?: Map<string, ArrayBuffer>;
+    /** Cover image data (JPEG or PNG) */
+    coverImage?: ArrayBuffer;
+    /**
+     * Audio narration data keyed by segment src/name.
+     * When provided alongside audioSegments, EPUB 3 Media Overlays (SMIL)
+     * are generated for synchronized audio playback.
+     */
+    audio?: Map<string, ArrayBuffer>;
+    /**
+     * Audio segment metadata (from Doc.audio.segments).
+     * Required together with `audio` to generate Media Overlays.
+     * Each segment's duration and startTime are used to build SMIL timing.
+     */
+    audioSegments?: AudioSegment[];
+    /** Total document duration in seconds (used for Media Overlay metadata) */
+    totalDuration?: number;
+}
+/**
+ * Convert a MarkdownDocument to an EPUB 3 file.
+ *
+ * Chapters are split at H1/H2 heading boundaries. All referenced images
+ * (provided via `options.images`) are embedded in the archive.
+ */
+export declare function markdownDocToEpub(doc: MarkdownDocument, options?: EpubExportOptions): Promise<ArrayBuffer>;
+/**
+ * Convert a squisq Doc to an EPUB 3 file.
+ *
+ * Convenience wrapper: Doc → MarkdownDocument → EPUB.
+ * When the Doc has audio segments and `options.audio` is provided,
+ * EPUB 3 Media Overlays are generated for narrated playback.
+ */
+export declare function docToEpub(doc: Doc, options?: EpubExportOptions): Promise<ArrayBuffer>;
+//# sourceMappingURL=export.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../src/epub/export.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEnE,OAAO,KAAK,EACV,gBAAgB,EASjB,MAAM,4BAA4B,CAAC;AAMpC,MAAM,WAAW,iBAAiB;IAChC,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mFAAmF;IACnF,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAClC,qCAAqC;IACrC,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB;;;;OAIG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACjC;;;;OAIG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAC/B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,gBAAgB,EACrB,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,WAAW,CAAC,CAmLtB;AAED;;;;;;GAMG;AACH,wBAAsB,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC,CAc/F"}