@bendyline/squisq-formats 1.3.0 → 1.4.0

package/dist/html/index.js

@@ -1,166 +1,33 @@
-/**
- * HTML Export Module — @bendyline/squisq-formats/html
- *
- * Exports squisq documents as self-contained HTML files or ZIP archives.
- *
- * Two export modes:
- *
- * 1. **Single HTML** (`docToHtml`) — Everything embedded in one file:
- *    - SquisqPlayer IIFE bundle inlined in `<script>`
- *    - Images base64-encoded as data URIs
- *    - Timer-based playback (no audio — too large for inline)
- *
- * 2. **ZIP Archive** (`docToHtmlZip`) — Multi-file package:
- *    - `index.html` referencing external `squisq-player.js`
- *    - `squisq-player.js` — the IIFE bundle
- *    - `images/` — extracted image files
- *    - `audio/` — optional audio segment files (enables full playback)
- *
- * @example
- * ```ts
- * import { PLAYER_BUNDLE } from '@bendyline/squisq-react/standalone-source';
- * import { docToHtml, docToHtmlZip } from '@bendyline/squisq-formats/html';
- *
- * // Single HTML file
- * const html = docToHtml(doc, { playerScript: PLAYER_BUNDLE, images });
- *
- * // ZIP archive
- * const zipBlob = await docToHtmlZip(doc, { playerScript: PLAYER_BUNDLE, images, audio });
- * ```
- */
-import JSZip from 'jszip';
-import { generateInlineHtml, generateExternalHtml, } from './htmlTemplate.js';
-import { extractFilename } from './imageUtils.js';
-/**
- * Normalize a doc-referenced path for use as a zip entry name. Strips
- * leading slashes and rejects any path that tries to escape the archive
- * root via `..` segments (a malicious or malformed doc shouldn't be able
- * to write outside the zip when extracted). Backslashes are folded to
- * forward slashes so Windows-authored paths still produce a consistent
- * tree across extractors.
- */
-function sanitizeZipPath(path) {
-    const normalized = path.replace(/\\/g, '/').replace(/^\/+/, '');
-    if (!normalized)
-        return null;
-    if (normalized.split('/').some((seg) => seg === '..'))
-        return null;
-    return normalized;
-}
-// ── Single HTML Export ─────────────────────────────────────────────
-/**
- * Export a Doc as a single, self-contained HTML file.
- *
- * The player JS is embedded inline, images are base64-encoded as data URIs,
- * and playback uses a timer (no audio) for compact file size.
- *
- * @param doc - The Doc to export
- * @param options - Export options (must include `playerScript`)
- * @returns Complete HTML document as a string
- *
- * @example
- * ```ts
- * const html = docToHtml(myDoc, {
- *   playerScript: PLAYER_BUNDLE,
- *   images: imageMap,
- *   title: 'My Document',
- *   mode: 'slideshow',
- * });
- * const blob = new Blob([html], { type: 'text/html' });
- * ```
- */
-export function docToHtml(doc, options) {
-    return generateInlineHtml(doc, options);
-}
-// ── ZIP Archive Export ─────────────────────────────────────────────
-/**
- * Export a Doc as a ZIP archive containing HTML, JS, images, and optionally audio.
- *
- * The archive structure:
- * ```
- * document.zip
- * ├── index.html           # HTML page referencing squisq-player.js
- * ├── squisq-player.js     # Standalone IIFE bundle
- * ├── images/              # Extracted image files
- * │   ├── hero.jpg
- * │   └── ...
- * └── audio/               # Optional audio segment files
- *     ├── intro.mp3
- *     └── ...
- * ```
- *
- * @param doc - The Doc to export
- * @param options - Export options (must include `playerScript`)
- * @returns A Promise resolving to a ZIP Blob
- *
- * @example
- * ```ts
- * const blob = await docToHtmlZip(myDoc, {
- *   playerScript: PLAYER_BUNDLE,
- *   images: imageMap,
- *   audio: audioMap,
- * });
- * // Trigger browser download
- * const url = URL.createObjectURL(blob);
- * ```
- */
-export async function docToHtmlZip(doc, options) {
-    const { playerScript, images, audio, mode = 'slideshow', title, autoPlay } = options;
-    const zip = new JSZip();
-    // 1. Add player JS as a separate file
-    zip.file('squisq-player.js', playerScript);
-    // 2. Add images preserving their original relative paths.
-    //
-    // We used to flatten everything into `images/<basename>`, but that
-    // requires the player to rewrite every `<img src>` at render time using
-    // the path map — and the static (non-slideshow) renderer doesn't do
-    // that, so its emitted `<img>` tags 404'd against the renamed assets.
-    // Keeping the original layout means direct `src="folder/file.png"`
-    // references just work, and the exported zip mirrors how the source
-    // folder is organized (e.g. pandoc-style `notes_files/` sidecars).
-    const imagePathMap = {};
-    if (images) {
-        for (const [originalPath, buffer] of images.entries()) {
-            const zipPath = sanitizeZipPath(originalPath);
-            if (!zipPath)
-                continue;
-            zip.file(zipPath, buffer);
-            imagePathMap[originalPath] = zipPath;
-        }
-    }
-    // 3. Add audio to audio/ folder and build path mapping
-    const audioPathMap = {};
-    if (audio) {
-        for (const [segmentKey, buffer] of audio.entries()) {
-            const filename = extractFilename(segmentKey);
-            // Ensure .mp3 extension
-            const finalName = filename.includes('.') ? filename : `${filename}.mp3`;
-            const zipPath = `audio/${finalName}`;
-            zip.file(zipPath, buffer);
-            audioPathMap[segmentKey] = zipPath;
-        }
-    }
-    // 4. Generate HTML that references external files
-    const html = generateExternalHtml(doc, {
-        playerScriptPath: 'squisq-player.js',
-        imagePathMap: Object.keys(imagePathMap).length > 0 ? imagePathMap : undefined,
-        audioPathMap: Object.keys(audioPathMap).length > 0 ? audioPathMap : undefined,
-        mode,
-        title,
-        autoPlay,
-    });
-    zip.file('index.html', html);
-    // 5. Generate ZIP blob
-    return zip.generateAsync({
-        type: 'blob',
-        compression: 'DEFLATE',
-        compressionOptions: { level: 6 },
-    });
-}
-// ── Re-exports ─────────────────────────────────────────────────────
-export { collectImagePaths } from './htmlTemplate.js';
-export { inferMimeType, arrayBufferToBase64DataUrl, extractFilename } from './imageUtils.js';
-export { markdownDocToPlainHtml } from './plainHtml.js';
-export { markdownDocsToPlainHtmlBundle, collectLinkRefs } from './plainHtmlBundle.js';
-export { markdownDocsToHtmlBundle } from './docsHtmlBundle.js';
+import {
+  collectImagePaths,
+  collectLinkRefs,
+  docToHtml,
+  docToHtmlZip,
+  htmlToMarkdown,
+  htmlToMarkdownDoc,
+  htmlToMarkdownDocSync,
+  markdownDocToPlainHtml,
+  markdownDocsToHtmlBundle,
+  markdownDocsToPlainHtmlBundle
+} from "../chunk-CRTC6DEX.js";
+import {
+  arrayBufferToBase64DataUrl,
+  extractFilename,
+  inferMimeType
+} from "../chunk-A3FHLTY5.js";
+export {
+  arrayBufferToBase64DataUrl,
+  collectImagePaths,
+  collectLinkRefs,
+  docToHtml,
+  docToHtmlZip,
+  extractFilename,
+  htmlToMarkdown,
+  htmlToMarkdownDoc,
+  htmlToMarkdownDocSync,
+  inferMimeType,
+  markdownDocToPlainHtml,
+  markdownDocsToHtmlBundle,
+  markdownDocsToPlainHtmlBundle
+};
 //# sourceMappingURL=index.js.map

package/dist/html/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/html/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAGH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EACL,kBAAkB,EAClB,oBAAoB,GAErB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAMlD;;;;;;;GAOG;AACH,SAAS,eAAe,CAAC,IAAY;IACnC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAChE,IAAI,CAAC,UAAU;QAAE,OAAO,IAAI,CAAC;IAC7B,IAAI,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACnE,OAAO,UAAU,CAAC;AACpB,CAAC;AAWD,sEAAsE;AAEtE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,SAAS,CAAC,GAAQ,EAAE,OAA0B;IAC5D,OAAO,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAC1C,CAAC;AAED,sEAAsE;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAQ,EAAE,OAA6B;IACxE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,GAAG,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAErF,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;IAExB,sCAAsC;IACtC,GAAG,CAAC,IAAI,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;IAE3C,0DAA0D;IAC1D,EAAE;IACF,mEAAmE;IACnE,wEAAwE;IACxE,oEAAoE;IACpE,sEAAsE;IACtE,mEAAmE;IACnE,oEAAoE;IACpE,mEAAmE;IACnE,MAAM,YAAY,GAA2B,EAAE,CAAC;IAChD,IAAI,MAAM,EAAE,CAAC;QACX,KAAK,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YACtD,MAAM,OAAO,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;YAC9C,IAAI,CAAC,OAAO;gBAAE,SAAS;YACvB,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC1B,YAAY,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;QACvC,CAAC;IACH,CAAC;IAED,uDAAuD;IACvD,MAAM,YAAY,GAA2B,EAAE,CAAC;IAChD,IAAI,KAAK,EAAE,CAAC;QACV,KAAK,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YACnD,MAAM,QAAQ,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;YAC7C,wBAAwB;YACxB,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,MAAM,CAAC;YACxE,MAAM,OAAO,GAAG,SAAS,SAAS,EAAE,CAAC;YACrC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC1B,YAAY,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;QACrC,CAAC;IACH,CAAC;IAED,kDAAkD;IAClD,MAAM,IAAI,GAAG,oBAAoB,CAAC,GAAG,EAAE;QACrC,gBAAgB,EAAE,kBAAkB;QACpC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;QAC7E,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;QAC7E,IAAI;QACJ,KAAK;QACL,QAAQ;KACT,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAE7B,uBAAuB;IACvB,OAAO,GAAG,CAAC,aAAa,CAAC;QACvB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,SAAS;QACtB,kBAAkB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;KACjC,CAAC,CAAC;AACL,CAAC;AAED,sEAAsE;AAEtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,0BAA0B,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAC7F,OAAO,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAE,6BAA6B,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/index.d.ts

@@ -1,38 +1,10 @@
-/**
- * @bendyline/squisq-formats
- *
- * Format converters for squisq documents. Converts between squisq's
- * MarkdownDocument / Doc and various file formats via Office Open XML.
- *
- * Supported formats:
- * - **DOCX** — Microsoft Word (import + export) ✅
- * - **PDF**  — Portable Document Format (import + export) ✅
- * - **PPTX** — Microsoft PowerPoint (export ✅, import planned)
- * - **XLSX** — Microsoft Excel (planned)
- *
- * All converters run in the browser — no server or native binaries required.
- * The shared `ooxml/` subpath export provides reusable OOXML infrastructure.
- *
- * @example
- * ```ts
- * // Import from root
- * import { markdownDocToDocx, docxToMarkdownDoc } from '@bendyline/squisq-formats';
- *
- * // Or import from subpath
- * import { markdownDocToDocx } from '@bendyline/squisq-formats/docx';
- * import { createPackage } from '@bendyline/squisq-formats/ooxml';
- * ```
- */
-export { markdownDocToDocx, docToDocx, docxToMarkdownDoc, docxToDoc } from './docx/index.js';
-export type { DocxExportOptions, DocxImportOptions } from './docx/index.js';
-export { markdownDocToPptx, docToPptx, pptxToMarkdownDoc, pptxToDoc } from './pptx/index.js';
-export type { PptxExportOptions, PptxImportOptions } from './pptx/index.js';
-export { markdownDocToXlsx, docToXlsx, xlsxToMarkdownDoc, xlsxToDoc } from './xlsx/index.js';
-export type { XlsxExportOptions, XlsxImportOptions } from './xlsx/index.js';
-export { markdownDocToPdf, docToPdf, pdfToMarkdownDoc, pdfToDoc, configurePdfWorker, } from './pdf/index.js';
-export type { PdfExportOptions, PdfImportOptions } from './pdf/index.js';
-export { docToHtml, docToHtmlZip, collectImagePaths } from './html/index.js';
-export type { HtmlExportOptions, HtmlZipExportOptions } from './html/index.js';
-export { markdownDocToEpub, docToEpub } from './epub/index.js';
-export type { EpubExportOptions } from './epub/index.js';
-//# sourceMappingURL=index.d.ts.map
+export { DocxExportOptions, DocxImportOptions, docToDocx, docxToDoc, docxToMarkdownDoc, markdownDocToDocx } from './docx/index.js';
+export { PptxExportOptions, PptxImportOptions, docToPptx, markdownDocToPptx, pptxToDoc, pptxToMarkdownDoc } from './pptx/index.js';
+export { XlsxExportOptions, XlsxImportOptions, docToXlsx, markdownDocToXlsx, xlsxToDoc, xlsxToMarkdownDoc } from './xlsx/index.js';
+export { CsvExportOptions, CsvImportOptions, csvToDoc, csvToMarkdownDoc, markdownDocToCsv, parseCsv } from './csv/index.js';
+export { PdfExportOptions, PdfImportOptions, configurePdfWorker, docToPdf, markdownDocToPdf, pdfToDoc, pdfToMarkdownDoc } from './pdf/index.js';
+export { HtmlExportOptions, HtmlImportOptions, HtmlZipExportOptions, collectImagePaths, docToHtml, docToHtmlZip, htmlToMarkdown, htmlToMarkdownDoc, htmlToMarkdownDocSync } from './html/index.js';
+export { EpubExportOptions, docToEpub, markdownDocToEpub } from './epub/index.js';
+import '@bendyline/squisq/schemas';
+import '@bendyline/squisq/markdown';
+import '@bendyline/squisq/storage';

package/dist/index.js

@@ -1,38 +1,81 @@
-/**
- * @bendyline/squisq-formats
- *
- * Format converters for squisq documents. Converts between squisq's
- * MarkdownDocument / Doc and various file formats via Office Open XML.
- *
- * Supported formats:
- * - **DOCX** — Microsoft Word (import + export) ✅
- * - **PDF**  — Portable Document Format (import + export) ✅
- * - **PPTX** — Microsoft PowerPoint (export ✅, import planned)
- * - **XLSX** — Microsoft Excel (planned)
- *
- * All converters run in the browser — no server or native binaries required.
- * The shared `ooxml/` subpath export provides reusable OOXML infrastructure.
- *
- * @example
- * ```ts
- * // Import from root
- * import { markdownDocToDocx, docxToMarkdownDoc } from '@bendyline/squisq-formats';
- *
- * // Or import from subpath
- * import { markdownDocToDocx } from '@bendyline/squisq-formats/docx';
- * import { createPackage } from '@bendyline/squisq-formats/ooxml';
- * ```
- */
-// DOCX (fully implemented)
-export { markdownDocToDocx, docToDocx, docxToMarkdownDoc, docxToDoc } from './docx/index.js';
-// PPTX (export implemented, import stub)
-export { markdownDocToPptx, docToPptx, pptxToMarkdownDoc, pptxToDoc } from './pptx/index.js';
-// XLSX (stub)
-export { markdownDocToXlsx, docToXlsx, xlsxToMarkdownDoc, xlsxToDoc } from './xlsx/index.js';
-// PDF (fully implemented)
-export { markdownDocToPdf, docToPdf, pdfToMarkdownDoc, pdfToDoc, configurePdfWorker, } from './pdf/index.js';
-// HTML (fully implemented)
-export { docToHtml, docToHtmlZip, collectImagePaths } from './html/index.js';
-// EPUB (export)
-export { markdownDocToEpub, docToEpub } from './epub/index.js';
+import {
+  docToEpub,
+  markdownDocToEpub
+} from "./chunk-ON232HJR.js";
+import {
+  docToDocx,
+  docxToDoc,
+  docxToMarkdownDoc,
+  markdownDocToDocx
+} from "./chunk-BJQIJ4S4.js";
+import {
+  docToPptx,
+  markdownDocToPptx,
+  pptxToDoc,
+  pptxToMarkdownDoc
+} from "./chunk-I2GFTEOV.js";
+import "./chunk-6M7Z25LA.js";
+import "./chunk-PN52A5AA.js";
+import {
+  docToXlsx,
+  markdownDocToXlsx,
+  xlsxToDoc,
+  xlsxToMarkdownDoc
+} from "./chunk-L53YIGYS.js";
+import {
+  csvToDoc,
+  csvToMarkdownDoc,
+  markdownDocToCsv,
+  parseCsv
+} from "./chunk-JBNVE2GV.js";
+import "./chunk-QSE7EWE7.js";
+import "./chunk-U4MRIFKL.js";
+import "./chunk-FMOIGA5T.js";
+import {
+  configurePdfWorker,
+  docToPdf,
+  markdownDocToPdf,
+  pdfToDoc,
+  pdfToMarkdownDoc
+} from "./chunk-APSIAEXL.js";
+import {
+  collectImagePaths,
+  docToHtml,
+  docToHtmlZip,
+  htmlToMarkdown,
+  htmlToMarkdownDoc,
+  htmlToMarkdownDocSync
+} from "./chunk-CRTC6DEX.js";
+import "./chunk-A3FHLTY5.js";
+export {
+  collectImagePaths,
+  configurePdfWorker,
+  csvToDoc,
+  csvToMarkdownDoc,
+  docToDocx,
+  docToEpub,
+  docToHtml,
+  docToHtmlZip,
+  docToPdf,
+  docToPptx,
+  docToXlsx,
+  docxToDoc,
+  docxToMarkdownDoc,
+  htmlToMarkdown,
+  htmlToMarkdownDoc,
+  htmlToMarkdownDocSync,
+  markdownDocToCsv,
+  markdownDocToDocx,
+  markdownDocToEpub,
+  markdownDocToPdf,
+  markdownDocToPptx,
+  markdownDocToXlsx,
+  parseCsv,
+  pdfToDoc,
+  pdfToMarkdownDoc,
+  pptxToDoc,
+  pptxToMarkdownDoc,
+  xlsxToDoc,
+  xlsxToMarkdownDoc
+};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,2BAA2B;AAC3B,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG7F,yCAAyC;AACzC,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG7F,cAAc;AACd,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG7F,0BAA0B;AAC1B,OAAO,EACL,gBAAgB,EAChB,QAAQ,EACR,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AAGxB,2BAA2B;AAC3B,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAG7E,gBAAgB;AAChB,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}