@bendyline/squisq-formats 2.0.1 → 2.1.0

package/dist/pptx/index.js

@@ -4,17 +4,17 @@ import {
   pptxToContainer,
   pptxToDoc,
   pptxToMarkdownDoc
-} from "../chunk-ABVI556T.js";
+} from "../chunk-RLU7UFYU.js";
 import {
   analyzePptxLayouts,
   inspectPptxLayouts
-} from "../chunk-VSYHZECT.js";
+} from "../chunk-QFLDYKCR.js";
 import "../chunk-6M7Z25LA.js";
 import "../chunk-PN52A5AA.js";
 import "../chunk-YRT7GQ5Y.js";
-import "../chunk-U32AG3G3.js";
+import "../chunk-KURGXM4I.js";
 import "../chunk-U4MRIFKL.js";
-import "../chunk-WC7WULGV.js";
+import "../chunk-7ARKUCQT.js";
 import "../chunk-FE6OJV6O.js";
 import "../chunk-SSUPBUF5.js";
 import "../chunk-MLX2BOJC.js";

package/dist/registry/index.js

@@ -5,7 +5,7 @@ import {
   defaultFormats,
   defaultRegistry,
   prepareConversion
-} from "../chunk-HTW2M27H.js";
+} from "../chunk-WQSHGBLN.js";
 import {
   ConversionError
 } from "../chunk-ODL3SSPT.js";

package/dist/xlsx/index.js

@@ -3,11 +3,11 @@ import {
   markdownDocToXlsx,
   xlsxToDoc,
   xlsxToMarkdownDoc
-} from "../chunk-VJJM2SSH.js";
+} from "../chunk-UGYF5AZE.js";
 import "../chunk-PN52A5AA.js";
-import "../chunk-U32AG3G3.js";
+import "../chunk-KURGXM4I.js";
 import "../chunk-U4MRIFKL.js";
-import "../chunk-WC7WULGV.js";
+import "../chunk-7ARKUCQT.js";
 import "../chunk-FE6OJV6O.js";
 export {
   docToXlsx,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bendyline/squisq-formats",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Document format converters — DOCX, PDF, OOXML import/export",
   "license": "MIT",
   "author": "Bendyline",
@@ -100,7 +100,7 @@
   },
   "dependencies": {
     "@xmldom/xmldom": "0.9.10",
-    "@bendyline/squisq": "2.0.1",
+    "@bendyline/squisq": "2.1.0",
     "jszip": "3.10.1",
     "pdf-lib": "1.17.1",
     "pdfjs-dist": "4.10.38"

package/src/__tests__/docxExport.test.ts

@@ -22,6 +22,7 @@ import type {
   MarkdownEmphasis,
   MarkdownInlineCode,
   MarkdownLink,
+  MarkdownContainerDirective,
 } from '@bendyline/squisq/markdown';
 
 import { markdownDocToDocx, docToDocx } from '../docx/export';
@@ -81,6 +82,39 @@ describe('markdownDocToDocx', () => {
     expect(body).toBeDefined();
   });
 
+  it('exports DOCX story directives to header and footer parts', async () => {
+    const doc: MarkdownDocument = {
+      type: 'document',
+      children: [
+        { type: 'paragraph', children: [{ type: 'text', value: 'Body' }] },
+        {
+          type: 'containerDirective',
+          name: 'docx-header',
+          children: [{ type: 'paragraph', children: [{ type: 'text', value: 'Header' }] }],
+        } satisfies MarkdownContainerDirective,
+        {
+          type: 'containerDirective',
+          name: 'docx-footer',
+          children: [{ type: 'paragraph', children: [{ type: 'text', value: 'Footer' }] }],
+        } satisfies MarkdownContainerDirective,
+      ],
+    };
+
+    const zip = await exportAndParse(doc);
+    const documentXml = await zip.file('word/document.xml')!.async('text');
+    const headerXml = await zip.file('word/header1.xml')!.async('text');
+    const footerXml = await zip.file('word/footer1.xml')!.async('text');
+    const relationships = await zip.file('word/_rels/document.xml.rels')!.async('text');
+
+    expect(documentXml).toContain('<w:headerReference');
+    expect(documentXml).toContain('<w:footerReference');
+    expect(documentXml).not.toContain('Header');
+    expect(headerXml).toContain('Header');
+    expect(footerXml).toContain('Footer');
+    expect(relationships).toContain('/relationships/header');
+    expect(relationships).toContain('/relationships/footer');
+  });
+
   // ============================================
   // Headings
   // ============================================

package/src/__tests__/docxImport.test.ts

@@ -14,9 +14,13 @@ import {
   REL_STYLES,
   REL_NUMBERING,
   REL_HYPERLINK,
+  REL_HEADER,
+  REL_FOOTER,
   CONTENT_TYPE_DOCX_DOCUMENT,
   CONTENT_TYPE_DOCX_STYLES,
   CONTENT_TYPE_DOCX_NUMBERING,
+  CONTENT_TYPE_DOCX_HEADER,
+  CONTENT_TYPE_DOCX_FOOTER,
 } from '../ooxml/namespaces';
 import { xmlDeclaration } from '../ooxml/xmlUtils';
 import { docxToMarkdownDoc, docxToDoc } from '../docx/import';
@@ -31,6 +35,7 @@ import type {
   MarkdownStrikethrough,
   MarkdownLink,
   MarkdownInlineNode,
+  MarkdownContainerDirective,
 } from '@bendyline/squisq/markdown';
 
 // ============================================
@@ -47,6 +52,7 @@ interface DocxFixtureOptions {
     target: string;
     targetMode?: 'External';
   }>;
+  extraParts?: Array<{ path: string; content: string; contentType: string }>;
 }
 
 async function buildTestDocx(options: DocxFixtureOptions): Promise<ArrayBuffer> {
@@ -81,6 +87,10 @@ async function buildTestDocx(options: DocxFixtureOptions): Promise<ArrayBuffer>
     pkg.addPart('word/numbering.xml', options.numberingXml, CONTENT_TYPE_DOCX_NUMBERING);
   }
 
+  for (const part of options.extraParts ?? []) {
+    pkg.addPart(part.path, part.content, part.contentType);
+  }
+
   // Root relationship
   pkg.addRelationship('', {
     id: 'rId1',
@@ -164,6 +174,25 @@ describe('docxToMarkdownDoc', () => {
     );
   });
 
+  it('imports visible content inside controls, revisions, and text boxes once', async () => {
+    const data = await buildTestDocx({
+      bodyXml:
+        `<w:p>` +
+        `<w:r><w:t>Body </w:t></w:r>` +
+        `<w:sdt><w:sdtContent><w:r><w:t>controlled </w:t></w:r></w:sdtContent></w:sdt>` +
+        `<w:ins><w:r><w:t>inserted </w:t></w:r></w:ins>` +
+        `<mc:AlternateContent xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006">` +
+        `<mc:Choice><w:drawing><w:txbxContent><w:p><w:r><w:t>text box</w:t></w:r></w:p></w:txbxContent></w:drawing></mc:Choice>` +
+        `<mc:Fallback><w:pict><w:txbxContent><w:p><w:r><w:t>fallback duplicate</w:t></w:r></w:p></w:txbxContent></w:pict></mc:Fallback>` +
+        `</mc:AlternateContent>` +
+        `</w:p>`,
+    });
+
+    const paragraph = docText(await docxToMarkdownDoc(data));
+    expect(paragraph).toContain('Body controlled inserted text box');
+    expect(paragraph).not.toContain('fallback duplicate');
+  });
+
   it('skips empty paragraphs', async () => {
     const data = await buildTestDocx({
       bodyXml: `<w:p><w:pPr/></w:p><w:p><w:r><w:t>Text</w:t></w:r></w:p>`,
@@ -331,6 +360,27 @@ describe('docxToMarkdownDoc', () => {
     expect(list.ordered).toBe(true);
   });
 
+  it('retains nested list text after an empty parent numbering paragraph', async () => {
+    const numberingXml =
+      xmlDeclaration() +
+      `<w:numbering xmlns:w="${NS_WML}">` +
+      `<w:abstractNum w:abstractNumId="3">` +
+      `<w:lvl w:ilvl="0"><w:numFmt w:val="decimal"/></w:lvl>` +
+      `<w:lvl w:ilvl="1"><w:numFmt w:val="decimal"/></w:lvl>` +
+      `</w:abstractNum>` +
+      `<w:num w:numId="3"><w:abstractNumId w:val="3"/></w:num>` +
+      `</w:numbering>`;
+    const data = await buildTestDocx({
+      bodyXml:
+        `<w:p><w:pPr><w:numPr><w:ilvl w:val="0"/><w:numId w:val="3"/></w:numPr></w:pPr></w:p>` +
+        `<w:p><w:pPr><w:numPr><w:ilvl w:val="1"/><w:numId w:val="3"/></w:numPr></w:pPr>` +
+        `<w:r><w:t>Nested content survives</w:t></w:r></w:p>`,
+      numberingXml,
+    });
+
+    expect(docText(await docxToMarkdownDoc(data))).toContain('Nested content survives');
+  });
+
   // ============================================
   // Tables
   // ============================================
@@ -363,6 +413,57 @@ describe('docxToMarkdownDoc', () => {
     expect((cell10.children[0] as MarkdownText).value).toBe('1');
   });
 
+  it('flattens nested table contents without losing their text', async () => {
+    const data = await buildTestDocx({
+      bodyXml:
+        `<w:tbl><w:tr><w:tc>` +
+        `<w:p><w:r><w:t>Outer</w:t></w:r></w:p>` +
+        `<w:tbl><w:tr>` +
+        `<w:tc><w:p><w:r><w:t>Nested A</w:t></w:r></w:p></w:tc>` +
+        `<w:tc><w:p><w:r><w:t>Nested B</w:t></w:r></w:p></w:tc>` +
+        `</w:tr></w:tbl>` +
+        `</w:tc></w:tr></w:tbl>`,
+    });
+
+    expect(docText(await docxToMarkdownDoc(data))).toContain('Outer Nested A Nested B');
+  });
+
+  it('imports headers and footers as explicit DOCX story directives', async () => {
+    const headerXml =
+      xmlDeclaration() +
+      `<w:hdr xmlns:w="${NS_WML}"><w:p><w:r><w:t>Header text</w:t></w:r></w:p></w:hdr>`;
+    const footerXml =
+      xmlDeclaration() +
+      `<w:ftr xmlns:w="${NS_WML}"><w:p><w:r><w:t>Footer text</w:t></w:r></w:p></w:ftr>`;
+    const data = await buildTestDocx({
+      bodyXml:
+        `<w:p><w:r><w:t>Body text</w:t></w:r></w:p>` +
+        `<w:sectPr><w:headerReference w:type="default" r:id="rIdHeader"/>` +
+        `<w:footerReference w:type="default" r:id="rIdFooter"/></w:sectPr>`,
+      documentRels: [
+        { id: 'rIdHeader', type: REL_HEADER, target: 'header1.xml' },
+        { id: 'rIdFooter', type: REL_FOOTER, target: 'footer1.xml' },
+      ],
+      extraParts: [
+        { path: 'word/header1.xml', content: headerXml, contentType: CONTENT_TYPE_DOCX_HEADER },
+        { path: 'word/footer1.xml', content: footerXml, contentType: CONTENT_TYPE_DOCX_FOOTER },
+      ],
+    });
+
+    const doc = await docxToMarkdownDoc(data);
+    const header = doc.children.find(
+      (node): node is MarkdownContainerDirective =>
+        node.type === 'containerDirective' && node.name === 'docx-header',
+    );
+    const footer = doc.children.find(
+      (node): node is MarkdownContainerDirective =>
+        node.type === 'containerDirective' && node.name === 'docx-footer',
+    );
+    expect(header?.attributes?.type).toBe('default');
+    expect(footer?.attributes?.type).toBe('default');
+    expect(docText(doc)).toContain('Body text Header text Footer text');
+  });
+
   // ============================================
   // Empty Document
   // ============================================
@@ -387,8 +488,28 @@ describe('docxToMarkdownDoc', () => {
     const para = doc.children[0] as MarkdownParagraph;
     expect(para.children.some((c: MarkdownInlineNode) => c.type === 'break')).toBe(true);
   });
+
+  it('retains tabs as visible word boundaries', async () => {
+    const data = await buildTestDocx({
+      bodyXml: `<w:p><w:r><w:t>Before</w:t><w:tab/><w:t>After</w:t></w:r></w:p>`,
+    });
+
+    expect(docText(await docxToMarkdownDoc(data))).toBe('Before After');
+  });
 });
 
+function docText(doc: Awaited<ReturnType<typeof docxToMarkdownDoc>>): string {
+  const text: string[] = [];
+  const visit = (node: unknown): void => {
+    if (!node || typeof node !== 'object') return;
+    const value = node as { type?: string; value?: string; children?: unknown[] };
+    if ((value.type === 'text' || value.type === 'code') && value.value) text.push(value.value);
+    value.children?.forEach(visit);
+  };
+  visit(doc);
+  return text.join(' ').replace(/\s+/g, ' ').trim();
+}
+
 // ============================================
 // docxToDoc convenience wrapper
 // ============================================

package/src/__tests__/html.test.ts

@@ -300,6 +300,10 @@ describe('docToHtml', () => {
     const html = docToHtml(doc, { playerScript: MOCK_PLAYER_SCRIPT, mode: 'static' });
 
     expect(html).toContain('"static"');
+    // The page rendition owns its own background/scrolling — the host shim
+    // must not hardcode a white background that fights themed pages.
+    expect(html).toContain('#squisq-root{display:block}');
+    expect(html).not.toContain('background:#fff');
   });
 
   it('inlines images as base64 data URIs', () => {

package/src/docx/export.ts

@@ -62,12 +62,16 @@ import {
   REL_HYPERLINK,
   REL_IMAGE,
   REL_FOOTNOTES,
+  REL_HEADER,
+  REL_FOOTER,
   CONTENT_TYPE_DOCX_DOCUMENT,
   CONTENT_TYPE_DOCX_STYLES,
   CONTENT_TYPE_DOCX_NUMBERING,
   CONTENT_TYPE_DOCX_SETTINGS,
   CONTENT_TYPE_DOCX_FONT_TABLE,
   CONTENT_TYPE_DOCX_FOOTNOTES,
+  CONTENT_TYPE_DOCX_HEADER,
+  CONTENT_TYPE_DOCX_FOOTER,
 } from '../ooxml/namespaces.js';
 import {
   DEPTH_TO_STYLE_ID,
@@ -135,8 +139,35 @@ export async function markdownDocToDocx(
       ? options
       : { ...options, themeId: readFrontmatterThemeId(doc.frontmatter) };
   const ctx = new ExportContext(resolvedOptions, doc);
-  const bodyXml = convertBlocks(doc.children, ctx);
-  return buildDocxPackage(bodyXml, ctx, resolvedOptions);
+  const stories = partitionDocumentStories(doc.children);
+  ctx.setRelationshipSource('document');
+  const bodyXml = convertBlocks(stories.body, ctx);
+  ctx.setRelationshipSource('header');
+  const headerXml = convertBlocks(stories.header, ctx);
+  ctx.setRelationshipSource('footer');
+  const footerXml = convertBlocks(stories.footer, ctx);
+  ctx.setRelationshipSource('document');
+  return buildDocxPackage(bodyXml, headerXml, footerXml, ctx, resolvedOptions);
+}
+
+interface DocumentStories {
+  body: MarkdownBlockNode[];
+  header: MarkdownBlockNode[];
+  footer: MarkdownBlockNode[];
+}
+
+function partitionDocumentStories(nodes: MarkdownBlockNode[]): DocumentStories {
+  const stories: DocumentStories = { body: [], header: [], footer: [] };
+  for (const node of nodes) {
+    if (node.type === 'containerDirective' && node.name === 'docx-header') {
+      stories.header.push(...node.children);
+    } else if (node.type === 'containerDirective' && node.name === 'docx-footer') {
+      stories.footer.push(...node.children);
+    } else {
+      stories.body.push(node);
+    }
+  }
+  return stories;
 }
 
 /**
@@ -172,8 +203,11 @@ class ExportContext {
     type: string;
     target: string;
     targetMode?: 'External';
+    source: DocxStoryPart;
   }> = [];
 
+  private relationshipSource: DocxStoryPart = 'document';
+
   /** Numbering definitions (abstract + num) */
   readonly numberingDefs: NumberingDef[] = [];
 
@@ -257,6 +291,10 @@ class ExportContext {
     return `rId${this.nextRelId++}`;
   }
 
+  setRelationshipSource(source: DocxStoryPart): void {
+    this.relationshipSource = source;
+  }
+
   /** Add a hyperlink relationship and return the rId */
   addHyperlink(url: string): string {
     const id = this.allocRelId();
@@ -265,6 +303,7 @@ class ExportContext {
       type: REL_HYPERLINK,
       target: url,
       targetMode: 'External',
+      source: this.relationshipSource,
     });
     return id;
   }
@@ -284,6 +323,7 @@ class ExportContext {
       id: relId,
       type: REL_IMAGE,
       target: `media/${filename}`,
+      source: this.relationshipSource,
     });
 
     return { relId, docPrId };
@@ -309,6 +349,8 @@ class ExportContext {
   }
 }
 
+type DocxStoryPart = 'document' | 'header' | 'footer';
+
 interface NumberingDef {
   numId: number;
   ordered: boolean;
@@ -384,6 +426,10 @@ function convertBlock(node: MarkdownBlockNode, ctx: ExportContext, listDepth: nu
       return convertMathBlock(node);
     case 'footnoteDefinition':
       return convertFootnoteDefinition(node, ctx);
+    case 'containerDirective':
+      // Non-DOCX directives have no native Word wrapper. Preserve their
+      // contents rather than silently dropping the entire subtree.
+      return convertBlocks(node.children, ctx);
     default:
       // Definition lists, directives, link definitions — skip or emit as plain text
       return '';
@@ -858,6 +904,8 @@ function convertFootnoteRef(node: MarkdownFootnoteReference, ctx: ExportContext)
 
 async function buildDocxPackage(
   bodyXml: string,
+  headerXml: string,
+  footerXml: string,
   ctx: ExportContext,
   options: DocxExportOptions,
 ): Promise<ArrayBuffer> {
@@ -870,11 +918,27 @@ async function buildDocxPackage(
   const settingsRelId = `rId${relCounter++}`;
   const fontTableRelId = `rId${relCounter++}`;
   const footnotesRelId = `rId${relCounter++}`;
+  const headerRelId = `rId${relCounter++}`;
+  const footerRelId = `rId${relCounter++}`;
+  const hasHeader = headerXml.trim().length > 0;
+  const hasFooter = footerXml.trim().length > 0;
 
   // --- word/document.xml ---
-  const documentXml = buildDocumentXml(bodyXml, ctx.backgroundColor);
+  const documentXml = buildDocumentXml(
+    bodyXml,
+    ctx.backgroundColor,
+    hasHeader ? headerRelId : undefined,
+    hasFooter ? footerRelId : undefined,
+  );
   pkg.addPart('word/document.xml', documentXml, CONTENT_TYPE_DOCX_DOCUMENT);
 
+  if (hasHeader) {
+    pkg.addPart('word/header1.xml', buildStoryXml('header', headerXml), CONTENT_TYPE_DOCX_HEADER);
+  }
+  if (hasFooter) {
+    pkg.addPart('word/footer1.xml', buildStoryXml('footer', footerXml), CONTENT_TYPE_DOCX_FOOTER);
+  }
+
   // --- word/styles.xml ---
   const stylesXml = buildStylesXml(options, ctx);
   pkg.addPart('word/styles.xml', stylesXml, CONTENT_TYPE_DOCX_STYLES);
@@ -942,9 +1006,31 @@ async function buildDocxPackage(
     });
   }
 
+  if (hasHeader) {
+    pkg.addRelationship('word/document.xml', {
+      id: headerRelId,
+      type: REL_HEADER,
+      target: 'header1.xml',
+    });
+  }
+
+  if (hasFooter) {
+    pkg.addRelationship('word/document.xml', {
+      id: footerRelId,
+      type: REL_FOOTER,
+      target: 'footer1.xml',
+    });
+  }
+
   // --- Dynamic relationships (hyperlinks, images) ---
   for (const rel of ctx.relationships) {
-    pkg.addRelationship('word/document.xml', {
+    const sourcePart =
+      rel.source === 'header'
+        ? 'word/header1.xml'
+        : rel.source === 'footer'
+          ? 'word/footer1.xml'
+          : 'word/document.xml';
+    pkg.addRelationship(sourcePart, {
       id: rel.id,
       type: rel.type,
       target: rel.target,
@@ -975,11 +1061,19 @@ async function buildDocxPackage(
 // XML Part Generators
 // ============================================
 
-function buildDocumentXml(bodyXml: string, backgroundColor?: string): string {
+function buildDocumentXml(
+  bodyXml: string,
+  backgroundColor?: string,
+  headerRelId?: string,
+  footerRelId?: string,
+): string {
   // `<w:background>` must be the FIRST child of `<w:document>` per the
   // WordprocessingML schema. Word also requires `<w:displayBackgroundShape/>`
   // in settings.xml before the bg actually paints (see buildSettingsXml).
   const backgroundEl = backgroundColor ? `<w:background w:color="${backgroundColor}"/>` : '';
+  const storyReferences =
+    (headerRelId ? `<w:headerReference w:type="default" r:id="${headerRelId}"/>` : '') +
+    (footerRelId ? `<w:footerReference w:type="default" r:id="${footerRelId}"/>` : '');
   return (
     xmlDeclaration() +
     `<w:document` +
@@ -997,6 +1091,7 @@ function buildDocumentXml(bodyXml: string, backgroundColor?: string): string {
     `<w:body>` +
     bodyXml +
     `<w:sectPr>` +
+    storyReferences +
     `<w:pgSz w:w="12240" w:h="15840"/>` +
     `<w:pgMar w:top="1440" w:right="1440" w:bottom="1440" w:left="1440" w:header="720" w:footer="720" w:gutter="0"/>` +
     `<w:cols w:space="720"/>` +
@@ -1006,6 +1101,19 @@ function buildDocumentXml(bodyXml: string, backgroundColor?: string): string {
   );
 }
 
+function buildStoryXml(kind: 'header' | 'footer', bodyXml: string): string {
+  const element = kind === 'header' ? 'hdr' : 'ftr';
+  return (
+    xmlDeclaration() +
+    `<w:${element}` +
+    ` xmlns:w="${NS_WML}"` +
+    ` xmlns:r="${NS_R}"` +
+    ` xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing">` +
+    bodyXml +
+    `</w:${element}>`
+  );
+}
+
 function buildStylesXml(options: DocxExportOptions, ctx: ExportContext): string {
   const font = ctx.font;
   const headingFont = ctx.headingFont;