@bendyline/squisq-formats 2.0.1 → 2.2.0

package/dist/container/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/container/index.ts"],"sourcesContent":["/**\n * Container ZIP serialization — convert between ContentContainer and ZIP archives.\n *\n * Uses JSZip (already a formats dependency) to serialize a ContentContainer to\n * a ZIP blob and to deserialize a ZIP blob into a MemoryContentContainer.\n *\n * ZIP structure mirrors the container's flat path hierarchy directly:\n *   index.md\n *   images/hero.jpg\n *   audio/narration.mp3\n *   timing.json\n */\n\nimport JSZip from 'jszip';\nimport type { ContentContainer } from '@bendyline/squisq/storage';\nimport { MemoryContentContainer } from '@bendyline/squisq/storage';\nimport {\n  assertSafeZipPath,\n  openBoundedZipArchive,\n  ZipSafetyError,\n  type ZipSafetyLimits,\n  type ZipSafetyErrorCode,\n  type ZipSafetyErrorOptions,\n} from '../shared/zipSafety.js';\n\nexport type ZipToContainerOptions = ZipSafetyLimits;\nexport interface ContainerToZipOptions {\n  /** STORE avoids producing archives that violate strict import compression-ratio policies. */\n  compression?: 'STORE' | 'DEFLATE';\n  /** JSZip DEFLATE level; ignored for STORE. */\n  compressionLevel?: number;\n}\nexport { ZipSafetyError };\nexport type { ZipSafetyLimits, ZipSafetyErrorCode, ZipSafetyErrorOptions };\n\n/**\n * Serialize a ContentContainer to a ZIP blob.\n *\n * All files in the container are written to the ZIP archive preserving\n * their path structure. The resulting blob can be saved as a .zip file.\n *\n * @param container — The container to serialize\n * @returns A Blob containing the ZIP archive\n */\nexport async function containerToZip(\n  container: ContentContainer,\n  options: ContainerToZipOptions = {},\n): Promise<Blob> {\n  const zip = new JSZip();\n  const entries = await container.listFiles();\n\n  for (const entry of entries) {\n    assertSafeZipPath(entry.path);\n    const data = await container.readFile(entry.path);\n    if (data) {\n      zip.file(entry.path, new Uint8Array(data));\n    }\n  }\n\n  const compression = options.compression ?? 'DEFLATE';\n  const compressionLevel = options.compressionLevel ?? 6;\n  if (!Number.isSafeInteger(compressionLevel) || compressionLevel < 1 || compressionLevel > 9) {\n    throw new Error('ZIP compression level must be an integer between 1 and 9');\n  }\n  return zip.generateAsync({\n    type: 'blob',\n    compression,\n    ...(compression === 'DEFLATE' ? { compressionOptions: { level: compressionLevel } } : {}),\n  });\n}\n\n/**\n * Deserialize a ZIP archive into a MemoryContentContainer.\n *\n * Reads all files from the ZIP and writes them into a new MemoryContentContainer.\n * Directory entries are skipped. The resulting container can be used immediately\n * for rendering, editing, or saving to persistent storage.\n *\n * @param zipData — The ZIP archive as ArrayBuffer, Uint8Array, or Blob\n * @returns A MemoryContentContainer populated with the ZIP's contents\n */\nexport async function zipToContainer(\n  zipData: ArrayBuffer | Uint8Array | Blob,\n  options: ZipToContainerOptions = {},\n): Promise<MemoryContentContainer> {\n  const archive = await openBoundedZipArchive(zipData, options);\n  const container = new MemoryContentContainer();\n  for (const { path } of archive.entries) {\n    const data = await archive.read(path);\n    if (data) await container.writeFile(path, data);\n    archive.release(path);\n  }\n  return container;\n}\n"],"mappings":";;;;;;;AAaA,OAAO,WAAW;AAElB,SAAS,8BAA8B;AA6BvC,eAAsB,eACpB,WACA,UAAiC,CAAC,GACnB;AACf,QAAM,MAAM,IAAI,MAAM;AACtB,QAAM,UAAU,MAAM,UAAU,UAAU;AAE1C,aAAW,SAAS,SAAS;AAC3B,sBAAkB,MAAM,IAAI;AAC5B,UAAM,OAAO,MAAM,UAAU,SAAS,MAAM,IAAI;AAChD,QAAI,MAAM;AACR,UAAI,KAAK,MAAM,MAAM,IAAI,WAAW,IAAI,CAAC;AAAA,IAC3C;AAAA,EACF;AAEA,QAAM,cAAc,QAAQ,eAAe;AAC3C,QAAM,mBAAmB,QAAQ,oBAAoB;AACrD,MAAI,CAAC,OAAO,cAAc,gBAAgB,KAAK,mBAAmB,KAAK,mBAAmB,GAAG;AAC3F,UAAM,IAAI,MAAM,0DAA0D;AAAA,EAC5E;AACA,SAAO,IAAI,cAAc;AAAA,IACvB,MAAM;AAAA,IACN;AAAA,IACA,GAAI,gBAAgB,YAAY,EAAE,oBAAoB,EAAE,OAAO,iBAAiB,EAAE,IAAI,CAAC;AAAA,EACzF,CAAC;AACH;AAYA,eAAsB,eACpB,SACA,UAAiC,CAAC,GACD;AACjC,QAAM,UAAU,MAAM,sBAAsB,SAAS,OAAO;AAC5D,QAAM,YAAY,IAAI,uBAAuB;AAC7C,aAAW,EAAE,KAAK,KAAK,QAAQ,SAAS;AACtC,UAAM,OAAO,MAAM,QAAQ,KAAK,IAAI;AACpC,QAAI,KAAM,OAAM,UAAU,UAAU,MAAM,IAAI;AAC9C,YAAQ,QAAQ,IAAI;AAAA,EACtB;AACA,SAAO;AACT;","names":[]}

package/dist/csv/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/docx/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/epub/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/extract-H6RXJMHP.js

@@ -1,15 +0,0 @@
-import {
-  extractDocxTheme,
-  extractPptxTheme,
-  extractXlsxTheme
-} from "./chunk-2KPARF2P.js";
-import "./chunk-XKUMNGBW.js";
-import "./chunk-YRT7GQ5Y.js";
-import "./chunk-WC7WULGV.js";
-import "./chunk-FE6OJV6O.js";
-export {
-  extractDocxTheme,
-  extractPptxTheme,
-  extractXlsxTheme
-};
-//# sourceMappingURL=extract-H6RXJMHP.js.map

package/dist/extract-H6RXJMHP.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/html/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/images-7FBWPKE3.js

@@ -1,7 +0,0 @@
-import {
-  extToMime
-} from "./chunk-O3GVVND4.js";
-export {
-  extToMime
-};
-//# sourceMappingURL=images-7FBWPKE3.js.map

package/dist/images-7FBWPKE3.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/infer/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/layouts-QVPK3ZCU.js

@@ -1,12 +0,0 @@
-import {
-  analyzePptxLayouts,
-  inspectPptxLayouts
-} from "./chunk-VSYHZECT.js";
-import "./chunk-YRT7GQ5Y.js";
-import "./chunk-WC7WULGV.js";
-import "./chunk-FE6OJV6O.js";
-export {
-  analyzePptxLayouts,
-  inspectPptxLayouts
-};
-//# sourceMappingURL=layouts-QVPK3ZCU.js.map

package/dist/layouts-QVPK3ZCU.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/mapTheme-IR27S6IV.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/ooxml/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/pdf/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/pptx/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/registry/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/xlsx/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/src/__tests__/container.test.ts

@@ -1,230 +0,0 @@
-/**
- * Tests for container ZIP serialization: containerToZip, zipToContainer.
- *
- * Verifies round-trip fidelity: write files to a container, serialize to ZIP,
- * deserialize back, and confirm all files are intact.
- */
-
-import { describe, it, expect } from 'vitest';
-import JSZip from 'jszip';
-import { MemoryContentContainer } from '@bendyline/squisq/storage';
-import { containerToZip, zipToContainer } from '../container/index';
-
-// ============================================
-// Helpers
-// ============================================
-
-/** Helper to read a Blob as ArrayBuffer (works in jsdom) */
-async function blobToArrayBuffer(blob: Blob): Promise<ArrayBuffer> {
-  return new Promise((resolve, reject) => {
-    const reader = new FileReader();
-    reader.onload = () => resolve(reader.result as ArrayBuffer);
-    reader.onerror = () => reject(reader.error);
-    reader.readAsArrayBuffer(blob);
-  });
-}
-
-// ============================================
-// containerToZip
-// ============================================
-
-describe('containerToZip', () => {
-  it('creates a valid ZIP from an empty container', async () => {
-    const container = new MemoryContentContainer();
-    const blob = await containerToZip(container);
-    expect(blob).toBeInstanceOf(Blob);
-    expect(blob.size).toBeGreaterThan(0);
-
-    // Should be parseable as a ZIP with no files
-    const zip = await JSZip.loadAsync(await blobToArrayBuffer(blob));
-    expect(Object.keys(zip.files)).toHaveLength(0);
-  });
-
-  it('includes all files from the container', async () => {
-    const container = new MemoryContentContainer();
-    await container.writeDocument('# Hello World');
-    await container.writeFile('images/hero.jpg', new Uint8Array([0xff, 0xd8, 0xff]), 'image/jpeg');
-    await container.writeFile('timing.json', new TextEncoder().encode('{"duration":10}'));
-
-    const blob = await containerToZip(container);
-    const zip = await JSZip.loadAsync(await blobToArrayBuffer(blob));
-
-    const filenames = Object.keys(zip.files)
-      .filter((f) => !zip.files[f].dir)
-      .sort();
-    expect(filenames).toEqual(['images/hero.jpg', 'index.md', 'timing.json']);
-  });
-
-  it('preserves file content', async () => {
-    const container = new MemoryContentContainer();
-    const markdown = '# Test Document\n\nSome content.';
-    await container.writeDocument(markdown);
-
-    const blob = await containerToZip(container);
-    const zip = await JSZip.loadAsync(await blobToArrayBuffer(blob));
-
-    const content = await zip.file('index.md')!.async('string');
-    expect(content).toBe(markdown);
-  });
-
-  it('preserves binary content', async () => {
-    const container = new MemoryContentContainer();
-    const binaryData = new Uint8Array([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]);
-    await container.writeFile('image.png', binaryData, 'image/png');
-
-    const blob = await containerToZip(container);
-    const zip = await JSZip.loadAsync(await blobToArrayBuffer(blob));
-
-    const data = await zip.file('image.png')!.async('uint8array');
-    expect(data).toEqual(binaryData);
-  });
-
-  it('refuses to create a ZIP with an unsafe container path', async () => {
-    const container = new MemoryContentContainer();
-    await container.writeFile('../outside.txt', new TextEncoder().encode('nope'));
-
-    await expect(containerToZip(container)).rejects.toThrow(/path is unsafe/i);
-  });
-});
-
-// ============================================
-// zipToContainer
-// ============================================
-
-describe('zipToContainer', () => {
-  it('loads files from a ZIP', async () => {
-    const zip = new JSZip();
-    zip.file('index.md', '# Hello');
-    zip.file('images/photo.jpg', new Uint8Array([0xff, 0xd8]));
-    const zipBlob = await zip.generateAsync({ type: 'blob' });
-
-    const container = await zipToContainer(zipBlob);
-    const entries = await container.listFiles();
-    expect(entries.map((e) => e.path).sort()).toEqual(['images/photo.jpg', 'index.md']);
-  });
-
-  it('preserves text content', async () => {
-    const zip = new JSZip();
-    zip.file('index.md', '# My Document\n\nParagraph.');
-    const zipBlob = await zip.generateAsync({ type: 'blob' });
-
-    const container = await zipToContainer(zipBlob);
-    expect(await container.readDocument()).toBe('# My Document\n\nParagraph.');
-  });
-
-  it('preserves binary content', async () => {
-    const original = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
-    const zip = new JSZip();
-    zip.file('data.bin', original);
-    const zipBlob = await zip.generateAsync({ type: 'blob' });
-
-    const container = await zipToContainer(zipBlob);
-    const data = await container.readFile('data.bin');
-    expect(new Uint8Array(data!)).toEqual(original);
-  });
-
-  it('skips directory entries', async () => {
-    const zip = new JSZip();
-    zip.folder('images');
-    zip.file('images/photo.jpg', new Uint8Array([0xff]));
-    const zipBlob = await zip.generateAsync({ type: 'blob' });
-
-    const container = await zipToContainer(zipBlob);
-    const entries = await container.listFiles();
-    // Only the file, not the directory
-    expect(entries).toHaveLength(1);
-    expect(entries[0].path).toBe('images/photo.jpg');
-  });
-
-  it('works with ArrayBuffer input', async () => {
-    const zip = new JSZip();
-    zip.file('readme.md', '# Read me');
-    const ab = await zip.generateAsync({ type: 'arraybuffer' });
-
-    const container = await zipToContainer(ab);
-    expect(await container.readDocument()).toBe('# Read me');
-  });
-
-  it('rejects archives that exceed the configured entry limit', async () => {
-    const zip = new JSZip();
-    zip.file('one.txt', '1');
-    zip.file('two.txt', '2');
-    const data = await zip.generateAsync({ type: 'arraybuffer' });
-    await expect(zipToContainer(data, { maxEntries: 1 })).rejects.toThrow(/archive has 2 files/);
-  });
-
-  it('rejects archives that exceed the configured uncompressed byte limit', async () => {
-    const zip = new JSZip();
-    zip.file('large.txt', '12345');
-    const data = await zip.generateAsync({ type: 'arraybuffer' });
-    await expect(zipToContainer(data, { maxUncompressedBytes: 4 })).rejects.toThrow(
-      /uncompressed content exceeds 4 byte limit/,
-    );
-  });
-
-  it('rejects traversal paths even when JSZip sanitizes their loaded key', async () => {
-    const zip = new JSZip();
-    zip.file('../outside.txt', 'nope');
-    const data = await zip.generateAsync({ type: 'arraybuffer' });
-
-    await expect(zipToContainer(data)).rejects.toThrow(/unsafe path.*\.\.\/outside\.txt/i);
-  });
-
-  it('rejects absolute and Windows-style archive paths', async () => {
-    for (const path of ['/absolute.txt', 'C:\\outside.txt']) {
-      const zip = new JSZip();
-      zip.file(path, 'nope');
-      const data = await zip.generateAsync({ type: 'arraybuffer' });
-      await expect(zipToContainer(data)).rejects.toThrow(/unsafe path/i);
-    }
-  });
-});
-
-// ============================================
-// Round-trip
-// ============================================
-
-describe('containerToZip / zipToContainer round-trip', () => {
-  it('round-trips a container with markdown and media', async () => {
-    // Create original container
-    const original = new MemoryContentContainer();
-    const markdown = '# Round Trip Test\n\n![hero](images/hero.jpg)\n\nSome text.';
-    await original.writeDocument(markdown);
-    await original.writeFile(
-      'images/hero.jpg',
-      new Uint8Array([0xff, 0xd8, 0xff, 0xe0]),
-      'image/jpeg',
-    );
-    await original.writeFile(
-      'audio/narration.mp3',
-      new Uint8Array([0x49, 0x44, 0x33]),
-      'audio/mpeg',
-    );
-    await original.writeFile('timing.json', new TextEncoder().encode('{"segments":[]}'));
-
-    // Serialize to ZIP
-    const zipBlob = await containerToZip(original);
-
-    // Deserialize back
-    const restored = await zipToContainer(zipBlob);
-
-    // Verify document
-    expect(await restored.readDocument()).toBe(markdown);
-    expect(await restored.getDocumentPath()).toBe('index.md');
-
-    // Verify all files present
-    const entries = (await restored.listFiles()).map((e) => e.path).sort();
-    expect(entries).toEqual(['audio/narration.mp3', 'images/hero.jpg', 'index.md', 'timing.json']);
-
-    // Verify binary content
-    const heroData = new Uint8Array((await restored.readFile('images/hero.jpg'))!);
-    expect(heroData).toEqual(new Uint8Array([0xff, 0xd8, 0xff, 0xe0]));
-
-    const audioData = new Uint8Array((await restored.readFile('audio/narration.mp3'))!);
-    expect(audioData).toEqual(new Uint8Array([0x49, 0x44, 0x33]));
-
-    // Verify JSON sidecar
-    const timingData = new TextDecoder().decode((await restored.readFile('timing.json'))!);
-    expect(timingData).toBe('{"segments":[]}');
-  });
-});