npm - odf-kit - Versions diffs - 0.4.0 → 0.5.0 - Mend

odf-kit 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

package/dist/reader/html-renderer.d.ts +31 -0
package/dist/reader/html-renderer.d.ts.map +1 -0
package/dist/reader/html-renderer.js +125 -0
package/dist/reader/html-renderer.js.map +1 -0
package/dist/reader/index.d.ts +39 -0
package/dist/reader/index.d.ts.map +1 -0
package/dist/reader/index.js +40 -0
package/dist/reader/index.js.map +1 -0
package/dist/reader/parser.d.ts +53 -0
package/dist/reader/parser.d.ts.map +1 -0
package/dist/reader/parser.js +409 -0
package/dist/reader/parser.js.map +1 -0
package/dist/reader/types.d.ts +139 -0
package/dist/reader/types.d.ts.map +1 -0
package/dist/reader/types.js +14 -0
package/dist/reader/types.js.map +1 -0
package/dist/reader/xml-parser.d.ts +45 -0
package/dist/reader/xml-parser.d.ts.map +1 -0
package/dist/reader/xml-parser.js +146 -0
package/dist/reader/xml-parser.js.map +1 -0
package/package.json +65 -61

package/dist/reader/html-renderer.d.ts ADDED Viewed

@@ -0,0 +1,31 @@
+/**
+ * HTML renderer for the ODT document model.
+ *
+ * Converts the structured document model produced by the ODT parser into
+ * an HTML string. Output is clean, semantic HTML using standard elements:
+ * <p>, <h1>–<h6>, <strong>, <em>, <u>, <s>, <sup>, <sub>, <a>, <br>,
+ * <ul>, <ol>, <li>, <table>, <tr>, <td>.
+ *
+ * Text content is HTML-escaped. Attribute values used in href are also
+ * HTML-escaped so the output is safe to embed in any HTML context.
+ *
+ * By default renderHtml() returns a complete HTML document with a
+ * <!DOCTYPE html> declaration. Pass { fragment: true } to receive only
+ * the inner body content, suitable for embedding in an existing page.
+ */
+import type { BodyNode, HtmlOptions } from "./types.js";
+/**
+ * Convert a document body to an HTML string.
+ *
+ * @param body - Array of BodyNode objects in document order.
+ * @param options - HTML output options.
+ * @returns HTML string. Full document by default; inner fragment when
+ *   options.fragment is true.
+ *
+ * @example
+ * ```typescript
+ * const html = renderHtml(doc.body, { fragment: true });
+ * ```
+ */
+export declare function renderHtml(body: BodyNode[], options?: HtmlOptions): string;
+//# sourceMappingURL=html-renderer.d.ts.map

package/dist/reader/html-renderer.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"html-renderer.d.ts","sourceRoot":"","sources":["../../src/reader/html-renderer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAiC,WAAW,EAAE,MAAM,YAAY,CAAC;AA6FvF;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,MAAM,CAI1E"}

package/dist/reader/html-renderer.js ADDED Viewed

@@ -0,0 +1,125 @@
+/**
+ * HTML renderer for the ODT document model.
+ *
+ * Converts the structured document model produced by the ODT parser into
+ * an HTML string. Output is clean, semantic HTML using standard elements:
+ * <p>, <h1>–<h6>, <strong>, <em>, <u>, <s>, <sup>, <sub>, <a>, <br>,
+ * <ul>, <ol>, <li>, <table>, <tr>, <td>.
+ *
+ * Text content is HTML-escaped. Attribute values used in href are also
+ * HTML-escaped so the output is safe to embed in any HTML context.
+ *
+ * By default renderHtml() returns a complete HTML document with a
+ * <!DOCTYPE html> declaration. Pass { fragment: true } to receive only
+ * the inner body content, suitable for embedding in an existing page.
+ */
+/**
+ * Escape the five characters that must be encoded in HTML text content
+ * and attribute values.
+ */
+function escapeHtml(text) {
+    return text
+        .replace(/&/g, "&amp;")
+        .replace(/</g, "&lt;")
+        .replace(/>/g, "&gt;")
+        .replace(/"/g, "&quot;")
+        .replace(/'/g, "&#39;");
+}
+/**
+ * Render a single TextSpan to an HTML string.
+ *
+ * Nesting order: bold → italic → underline → strikethrough →
+ * superscript/subscript → hyperlink. This order matches common browser
+ * rendering conventions and produces valid, readable HTML.
+ */
+function renderSpan(span) {
+    if (span.lineBreak)
+        return "<br>";
+    let html = escapeHtml(span.text);
+    if (span.bold)
+        html = `<strong>${html}</strong>`;
+    if (span.italic)
+        html = `<em>${html}</em>`;
+    if (span.underline)
+        html = `<u>${html}</u>`;
+    if (span.strikethrough)
+        html = `<s>${html}</s>`;
+    if (span.superscript)
+        html = `<sup>${html}</sup>`;
+    if (span.subscript)
+        html = `<sub>${html}</sub>`;
+    if (span.href !== undefined)
+        html = `<a href="${escapeHtml(span.href)}">${html}</a>`;
+    return html;
+}
+/** Render an array of TextSpan objects to a concatenated HTML string. */
+function renderSpans(spans) {
+    return spans.map(renderSpan).join("");
+}
+/** Render a ListNode to an HTML <ul> or <ol> string. */
+function renderList(list) {
+    const tag = list.ordered ? "ol" : "ul";
+    const items = list.items
+        .map((item) => {
+        const content = renderSpans(item.spans);
+        const nested = item.children !== undefined ? renderList(item.children) : "";
+        return `<li>${content}${nested}</li>`;
+    })
+        .join("");
+    return `<${tag}>${items}</${tag}>`;
+}
+/** Render a TableNode to an HTML <table> string. */
+function renderTable(table) {
+    const rows = table.rows
+        .map((row) => {
+        const cells = row.cells
+            .map((cell) => {
+            const attrParts = [];
+            if (cell.colSpan !== undefined && cell.colSpan > 1) {
+                attrParts.push(`colspan="${cell.colSpan}"`);
+            }
+            if (cell.rowSpan !== undefined && cell.rowSpan > 1) {
+                attrParts.push(`rowspan="${cell.rowSpan}"`);
+            }
+            const attrs = attrParts.length > 0 ? " " + attrParts.join(" ") : "";
+            return `<td${attrs}>${renderSpans(cell.spans)}</td>`;
+        })
+            .join("");
+        return `<tr>${cells}</tr>`;
+    })
+        .join("");
+    return `<table>${rows}</table>`;
+}
+/** Render a single BodyNode to an HTML string. */
+function renderNode(node) {
+    switch (node.kind) {
+        case "paragraph":
+            return `<p>${renderSpans(node.spans)}</p>`;
+        case "heading":
+            return `<h${node.level}>${renderSpans(node.spans)}</h${node.level}>`;
+        case "list":
+            return renderList(node);
+        case "table":
+            return renderTable(node);
+    }
+}
+/**
+ * Convert a document body to an HTML string.
+ *
+ * @param body - Array of BodyNode objects in document order.
+ * @param options - HTML output options.
+ * @returns HTML string. Full document by default; inner fragment when
+ *   options.fragment is true.
+ *
+ * @example
+ * ```typescript
+ * const html = renderHtml(doc.body, { fragment: true });
+ * ```
+ */
+export function renderHtml(body, options) {
+    const inner = body.map(renderNode).join("\n");
+    if (options?.fragment === true)
+        return inner;
+    return `<!DOCTYPE html>\n<html>\n<body>\n${inner}\n</body>\n</html>`;
+}
+//# sourceMappingURL=html-renderer.js.map

package/dist/reader/html-renderer.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"html-renderer.js","sourceRoot":"","sources":["../../src/reader/html-renderer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH;;;GAGG;AACH,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,IAAI;SACR,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;SACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC;SACvB,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,IAAc;IAChC,IAAI,IAAI,CAAC,SAAS;QAAE,OAAO,MAAM,CAAC;IAElC,IAAI,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEjC,IAAI,IAAI,CAAC,IAAI;QAAE,IAAI,GAAG,WAAW,IAAI,WAAW,CAAC;IACjD,IAAI,IAAI,CAAC,MAAM;QAAE,IAAI,GAAG,OAAO,IAAI,OAAO,CAAC;IAC3C,IAAI,IAAI,CAAC,SAAS;QAAE,IAAI,GAAG,MAAM,IAAI,MAAM,CAAC;IAC5C,IAAI,IAAI,CAAC,aAAa;QAAE,IAAI,GAAG,MAAM,IAAI,MAAM,CAAC;IAChD,IAAI,IAAI,CAAC,WAAW;QAAE,IAAI,GAAG,QAAQ,IAAI,QAAQ,CAAC;IAClD,IAAI,IAAI,CAAC,SAAS;QAAE,IAAI,GAAG,QAAQ,IAAI,QAAQ,CAAC;IAChD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;QAAE,IAAI,GAAG,YAAY,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC;IAErF,OAAO,IAAI,CAAC;AACd,CAAC;AAED,yEAAyE;AACzE,SAAS,WAAW,CAAC,KAAiB;IACpC,OAAO,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxC,CAAC;AAED,wDAAwD;AACxD,SAAS,UAAU,CAAC,IAAc;IAChC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IACvC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK;SACrB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,OAAO,OAAO,OAAO,GAAG,MAAM,OAAO,CAAC;IACxC,CAAC,CAAC;SACD,IAAI,CAAC,EAAE,CAAC,CAAC;IACZ,OAAO,IAAI,GAAG,IAAI,KAAK,KAAK,GAAG,GAAG,CAAC;AACrC,CAAC;AAED,oDAAoD;AACpD,SAAS,WAAW,CAAC,KAAgB;IACnC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI;SACpB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK;aACpB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACZ,MAAM,SAAS,GAAa,EAAE,CAAC;YAC/B,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;gBACnD,SAAS,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;YAC9C,CAAC;YACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;gBACnD,SAAS,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;YAC9C,CAAC;YACD,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACpE,OAAO,MAAM,KAAK,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QACvD,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,CAAC;QACZ,OAAO,OAAO,KAAK,OAAO,CAAC;IAC7B,CAAC,CAAC;SACD,IAAI,CAAC,EAAE,CAAC,CAAC;IACZ,OAAO,UAAU,IAAI,UAAU,CAAC;AAClC,CAAC;AAED,kDAAkD;AAClD,SAAS,UAAU,CAAC,IAAc;IAChC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,WAAW;YACd,OAAO,MAAM,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAC7C,KAAK,SAAS;YACZ,OAAO,KAAK,IAAI,CAAC,KAAK,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,GAAG,CAAC;QACvE,KAAK,MAAM;YACT,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC;QAC1B,KAAK,OAAO;YACV,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,UAAU,CAAC,IAAgB,EAAE,OAAqB;IAChE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9C,IAAI,OAAO,EAAE,QAAQ,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC7C,OAAO,oCAAoC,KAAK,oBAAoB,CAAC;AACvE,CAAC"}

package/dist/reader/index.d.ts ADDED Viewed

@@ -0,0 +1,39 @@
+/**
+ * Public API for the odf-kit ODT reader.
+ *
+ * Import from "odf-kit/reader" (separate from the main "odf-kit" import
+ * so the reader is only bundled when explicitly needed):
+ *
+ * ```typescript
+ * import { readOdt, odtToHtml } from "odf-kit/reader";
+ * ```
+ *
+ * readOdt() returns an OdtDocumentModel with a body array and a toHtml()
+ * method. odtToHtml() is a convenience wrapper that calls readOdt().toHtml()
+ * in a single step.
+ */
+export { readOdt } from "./parser.js";
+export type { OdtDocumentModel, OdtMetadata, BodyNode, ParagraphNode, HeadingNode, ListNode, ListItemNode, TableNode, TableRowNode, TableCellNode, TextSpan, HtmlOptions, } from "./types.js";
+import type { HtmlOptions } from "./types.js";
+/**
+ * Convert an .odt file directly to an HTML string.
+ *
+ * Convenience wrapper around readOdt().toHtml(). Use readOdt() directly
+ * when you need access to the document model or metadata.
+ *
+ * @param bytes - The raw .odt file as a Uint8Array.
+ * @param options - HTML output options.
+ * @returns HTML string. Full document by default; inner fragment when
+ *   options.fragment is true.
+ *
+ * @example
+ * ```typescript
+ * import { odtToHtml } from "odf-kit/reader";
+ * import { readFileSync } from "node:fs";
+ *
+ * const bytes = new Uint8Array(readFileSync("document.odt"));
+ * const html = odtToHtml(bytes, { fragment: true });
+ * ```
+ */
+export declare function odtToHtml(bytes: Uint8Array, options?: HtmlOptions): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/reader/index.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/reader/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,YAAY,EACV,gBAAgB,EAChB,WAAW,EACX,QAAQ,EACR,aAAa,EACb,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,WAAW,GACZ,MAAM,YAAY,CAAC;AAGpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,MAAM,CAE1E"}

package/dist/reader/index.js ADDED Viewed

@@ -0,0 +1,40 @@
+/**
+ * Public API for the odf-kit ODT reader.
+ *
+ * Import from "odf-kit/reader" (separate from the main "odf-kit" import
+ * so the reader is only bundled when explicitly needed):
+ *
+ * ```typescript
+ * import { readOdt, odtToHtml } from "odf-kit/reader";
+ * ```
+ *
+ * readOdt() returns an OdtDocumentModel with a body array and a toHtml()
+ * method. odtToHtml() is a convenience wrapper that calls readOdt().toHtml()
+ * in a single step.
+ */
+export { readOdt } from "./parser.js";
+import { readOdt } from "./parser.js";
+/**
+ * Convert an .odt file directly to an HTML string.
+ *
+ * Convenience wrapper around readOdt().toHtml(). Use readOdt() directly
+ * when you need access to the document model or metadata.
+ *
+ * @param bytes - The raw .odt file as a Uint8Array.
+ * @param options - HTML output options.
+ * @returns HTML string. Full document by default; inner fragment when
+ *   options.fragment is true.
+ *
+ * @example
+ * ```typescript
+ * import { odtToHtml } from "odf-kit/reader";
+ * import { readFileSync } from "node:fs";
+ *
+ * const bytes = new Uint8Array(readFileSync("document.odt"));
+ * const html = odtToHtml(bytes, { fragment: true });
+ * ```
+ */
+export function odtToHtml(bytes, options) {
+    return readOdt(bytes).toHtml(options);
+}
+//# sourceMappingURL=index.js.map

package/dist/reader/index.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/reader/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAgBtC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,SAAS,CAAC,KAAiB,EAAE,OAAqB;IAChE,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACxC,CAAC"}

package/dist/reader/parser.d.ts ADDED Viewed

@@ -0,0 +1,53 @@
+/**
+ * ODT parser — the core of the odf-kit reader.
+ *
+ * Unpacks an .odt file (ZIP), parses content.xml and meta.xml, builds
+ * the structured OdtDocumentModel, and wires up the toHtml() method.
+ *
+ * The parsing pipeline:
+ * 1. Unzip the .odt bytes with fflate
+ * 2. Parse content.xml with parseXml — produces an XmlElementNode tree
+ * 3. Build style maps from <office:automatic-styles> so character
+ *    formatting (bold, italic, etc.) and list types can be resolved
+ * 4. Walk <office:body>/<office:text> to produce BodyNode[]
+ * 5. Parse meta.xml (if present) for document metadata
+ * 6. Return an OdtDocumentModel whose toHtml() delegates to renderHtml()
+ *
+ * Exported for unit testing: parseMetaXml is tested in isolation.
+ * Internal helpers (buildStyleMaps, parseBodyNodes, etc.) are tested
+ * indirectly through readOdt round-trip integration tests.
+ */
+import type { OdtDocumentModel, OdtMetadata } from "./types.js";
+/**
+ * Parse a meta.xml string and return the document metadata.
+ *
+ * Exported so it can be tested in isolation with known XML strings
+ * without needing a full .odt ZIP file.
+ *
+ * @param metaXml - Content of meta.xml as a string.
+ * @returns Populated OdtMetadata object. Missing fields are undefined.
+ */
+export declare function parseMetaXml(metaXml: string): OdtMetadata;
+/**
+ * Parse an .odt file and return a structured document model.
+ *
+ * Reads content.xml for the document body and automatic styles, and
+ * meta.xml for document metadata. Both files are always present in
+ * spec-compliant .odt files.
+ *
+ * @param bytes - The raw .odt file as a Uint8Array.
+ * @returns A populated OdtDocumentModel with body, metadata, and toHtml().
+ * @throws Error if the input is not a valid ZIP or is missing content.xml.
+ *
+ * @example
+ * ```typescript
+ * import { readOdt } from "odf-kit/reader";
+ * import { readFileSync } from "node:fs";
+ *
+ * const bytes = new Uint8Array(readFileSync("document.odt"));
+ * const doc = readOdt(bytes);
+ * console.log(doc.body.length, "body nodes");
+ * ```
+ */
+export declare function readOdt(bytes: Uint8Array): OdtDocumentModel;
+//# sourceMappingURL=parser.d.ts.map

package/dist/reader/parser.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/reader/parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAMH,OAAO,KAAK,EACV,gBAAgB,EAChB,WAAW,EAWZ,MAAM,YAAY,CAAC;AAgXpB;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,CAuBzD;AAMD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,UAAU,GAAG,gBAAgB,CAwB3D"}

package/dist/reader/parser.js ADDED Viewed

@@ -0,0 +1,409 @@
+/**
+ * ODT parser — the core of the odf-kit reader.
+ *
+ * Unpacks an .odt file (ZIP), parses content.xml and meta.xml, builds
+ * the structured OdtDocumentModel, and wires up the toHtml() method.
+ *
+ * The parsing pipeline:
+ * 1. Unzip the .odt bytes with fflate
+ * 2. Parse content.xml with parseXml — produces an XmlElementNode tree
+ * 3. Build style maps from <office:automatic-styles> so character
+ *    formatting (bold, italic, etc.) and list types can be resolved
+ * 4. Walk <office:body>/<office:text> to produce BodyNode[]
+ * 5. Parse meta.xml (if present) for document metadata
+ * 6. Return an OdtDocumentModel whose toHtml() delegates to renderHtml()
+ *
+ * Exported for unit testing: parseMetaXml is tested in isolation.
+ * Internal helpers (buildStyleMaps, parseBodyNodes, etc.) are tested
+ * indirectly through readOdt round-trip integration tests.
+ */
+import { unzipSync, strFromU8 } from "fflate";
+import { parseXml } from "./xml-parser.js";
+import { renderHtml } from "./html-renderer.js";
+// ============================================================
+// Internal XML navigation helpers
+// ============================================================
+/** Return the first direct element child with the given tag, or undefined. */
+function findElement(node, tag) {
+    for (const child of node.children) {
+        if (child.type === "element" && child.tag === tag)
+            return child;
+    }
+    return undefined;
+}
+/** Return the concatenated text content of all direct text children. */
+function textContent(node) {
+    return node.children
+        .filter((c) => c.type === "text")
+        .map((c) => c.text)
+        .join("");
+}
+/**
+ * Merge a base character style with an override.
+ *
+ * The override wins for any property it explicitly sets (true).
+ * Unset properties in the override fall back to the base.
+ * Since odf-kit only ever sets properties to true (never explicitly
+ * to false), this produces correct inheritance for all generated output.
+ */
+function mergeStyle(base, override) {
+    const result = {};
+    if (base.bold || override.bold)
+        result.bold = true;
+    if (base.italic || override.italic)
+        result.italic = true;
+    if (base.underline || override.underline)
+        result.underline = true;
+    if (base.strikethrough || override.strikethrough)
+        result.strikethrough = true;
+    if (base.superscript || override.superscript)
+        result.superscript = true;
+    if (base.subscript || override.subscript)
+        result.subscript = true;
+    return result;
+}
+/** Build a TextSpan from text and resolved formatting, omitting falsy properties. */
+function makeSpan(text, style, href) {
+    const span = { text };
+    if (style.bold)
+        span.bold = true;
+    if (style.italic)
+        span.italic = true;
+    if (style.underline)
+        span.underline = true;
+    if (style.strikethrough)
+        span.strikethrough = true;
+    if (style.superscript)
+        span.superscript = true;
+    if (style.subscript)
+        span.subscript = true;
+    if (href !== undefined)
+        span.href = href;
+    return span;
+}
+/**
+ * Scan a styles container element (either office:automatic-styles or
+ * office:styles) and populate the provided style maps in place.
+ */
+function scanStylesElement(container, charStyles, listOrdered) {
+    for (const child of container.children) {
+        if (child.type !== "element")
+            continue;
+        if (child.tag === "style:style") {
+            const name = child.attrs["style:name"];
+            if (!name)
+                continue;
+            const textPropsEl = findElement(child, "style:text-properties");
+            if (!textPropsEl)
+                continue;
+            const style = {};
+            const p = textPropsEl.attrs;
+            if (p["fo:font-weight"] === "bold")
+                style.bold = true;
+            if (p["fo:font-style"] === "italic")
+                style.italic = true;
+            const underlineStyle = p["style:text-underline-style"];
+            if (underlineStyle !== undefined && underlineStyle !== "none")
+                style.underline = true;
+            const strikeStyle = p["style:text-line-through-style"];
+            if (strikeStyle !== undefined && strikeStyle !== "none")
+                style.strikethrough = true;
+            const textPosition = p["style:text-position"];
+            if (textPosition !== undefined) {
+                if (textPosition.startsWith("super"))
+                    style.superscript = true;
+                if (textPosition.startsWith("sub"))
+                    style.subscript = true;
+            }
+            charStyles.set(name, style);
+            continue;
+        }
+        if (child.tag === "text:list-style") {
+            const name = child.attrs["style:name"];
+            if (!name)
+                continue;
+            for (const levelChild of child.children) {
+                if (levelChild.type !== "element")
+                    continue;
+                if (levelChild.attrs["text:level"] !== "1")
+                    continue;
+                if (levelChild.tag === "text:list-level-style-number") {
+                    listOrdered.set(name, true);
+                }
+                else if (levelChild.tag === "text:list-level-style-bullet") {
+                    listOrdered.set(name, false);
+                }
+            }
+        }
+    }
+}
+/**
+ * Build style maps from both <office:automatic-styles> and <office:styles>
+ * in a parsed content.xml tree.
+ *
+ * List styles defined by odf-kit appear in <office:styles> (named styles),
+ * while character formatting automatic styles appear in
+ * <office:automatic-styles>. Scanning both ensures all styles are resolved.
+ */
+function buildStyleMaps(contentRoot) {
+    const charStyles = new Map();
+    const listOrdered = new Map();
+    const autoStylesEl = findElement(contentRoot, "office:automatic-styles");
+    if (autoStylesEl)
+        scanStylesElement(autoStylesEl, charStyles, listOrdered);
+    const namedStylesEl = findElement(contentRoot, "office:styles");
+    if (namedStylesEl)
+        scanStylesElement(namedStylesEl, charStyles, listOrdered);
+    return { charStyles, listOrdered };
+}
+// ============================================================
+// Inline span parsing
+// ============================================================
+/**
+ * Parse the inline content of a paragraph, heading, list item, or table
+ * cell into an array of TextSpan objects.
+ *
+ * Recursively handles nested <text:span>, <text:a>, <text:line-break>,
+ * <text:tab>, and <text:s> (ODF non-breaking space element).
+ *
+ * @param node - The container element whose children are walked.
+ * @param charStyles - Resolved character style map from automatic-styles.
+ * @param baseStyle - Inherited character formatting from the container.
+ * @param href - Inherited hyperlink href, set when inside <text:a>.
+ */
+function parseSpans(node, charStyles, baseStyle = {}, href) {
+    const spans = [];
+    for (const child of node.children) {
+        if (child.type === "text") {
+            if (child.text.length > 0) {
+                spans.push(makeSpan(child.text, baseStyle, href));
+            }
+            continue;
+        }
+        switch (child.tag) {
+            case "text:line-break":
+                spans.push({ text: "", lineBreak: true });
+                break;
+            case "text:tab":
+                spans.push(makeSpan("\t", baseStyle, href));
+                break;
+            case "text:s": {
+                // ODF space element — text:c gives the repeat count (default 1)
+                const count = parseInt(child.attrs["text:c"] ?? "1", 10);
+                spans.push(makeSpan(" ".repeat(count), baseStyle, href));
+                break;
+            }
+            case "text:span": {
+                const styleName = child.attrs["text:style-name"];
+                const spanStyle = styleName !== undefined ? (charStyles.get(styleName) ?? {}) : {};
+                const merged = mergeStyle(baseStyle, spanStyle);
+                spans.push(...parseSpans(child, charStyles, merged, href));
+                break;
+            }
+            case "text:a": {
+                const childHref = child.attrs["xlink:href"] ?? href;
+                spans.push(...parseSpans(child, charStyles, baseStyle, childHref));
+                break;
+            }
+            default:
+                // Unknown inline elements: recurse to pick up any text children
+                spans.push(...parseSpans(child, charStyles, baseStyle, href));
+                break;
+        }
+    }
+    return spans;
+}
+// ============================================================
+// Body node parsers
+// ============================================================
+/** Parse a <text:list> element into a ListNode. */
+function parseList(listEl, styles) {
+    const styleName = listEl.attrs["text:style-name"] ?? "";
+    const ordered = styles.listOrdered.get(styleName) ?? false;
+    const items = [];
+    for (const child of listEl.children) {
+        if (child.type !== "element" || child.tag !== "text:list-item")
+            continue;
+        let spans = [];
+        let nested;
+        for (const itemChild of child.children) {
+            if (itemChild.type !== "element")
+                continue;
+            if (itemChild.tag === "text:p" || itemChild.tag === "text:h") {
+                spans = spans.concat(parseSpans(itemChild, styles.charStyles));
+            }
+            else if (itemChild.tag === "text:list") {
+                nested = parseList(itemChild, styles);
+            }
+        }
+        const item = { spans };
+        if (nested !== undefined)
+            item.children = nested;
+        items.push(item);
+    }
+    return { kind: "list", ordered, items };
+}
+/** Parse a <table:table> element into a TableNode. */
+function parseTable(tableEl, styles) {
+    const rows = [];
+    for (const child of tableEl.children) {
+        if (child.type !== "element" || child.tag !== "table:table-row")
+            continue;
+        const cells = [];
+        for (const cellEl of child.children) {
+            if (cellEl.type !== "element")
+                continue;
+            // Skip covered cells — they are placeholders for merged cell spans
+            if (cellEl.tag === "table:covered-table-cell")
+                continue;
+            if (cellEl.tag !== "table:table-cell")
+                continue;
+            const colSpan = parseInt(cellEl.attrs["table:number-columns-spanned"] ?? "1", 10);
+            const rowSpan = parseInt(cellEl.attrs["table:number-rows-spanned"] ?? "1", 10);
+            // Collect spans from all <text:p> children (multi-paragraph cells
+            // are concatenated for Tier 1 — paragraph breaks within cells are
+            // not yet represented in the model)
+            let spans = [];
+            for (const cellChild of cellEl.children) {
+                if (cellChild.type === "element" && cellChild.tag === "text:p") {
+                    spans = spans.concat(parseSpans(cellChild, styles.charStyles));
+                }
+            }
+            const cell = { spans };
+            if (colSpan > 1)
+                cell.colSpan = colSpan;
+            if (rowSpan > 1)
+                cell.rowSpan = rowSpan;
+            cells.push(cell);
+        }
+        rows.push({ cells });
+    }
+    return { kind: "table", rows };
+}
+/**
+ * Walk the children of an <office:text> (or <text:section>) element and
+ * produce an ordered array of BodyNode objects.
+ *
+ * Handles paragraphs, headings, lists, tables, and sections (which are
+ * transparent containers). All other elements are skipped.
+ */
+function parseBodyNodes(bodyTextEl, styles) {
+    const nodes = [];
+    for (const child of bodyTextEl.children) {
+        if (child.type !== "element")
+            continue;
+        switch (child.tag) {
+            case "text:p": {
+                const para = {
+                    kind: "paragraph",
+                    spans: parseSpans(child, styles.charStyles),
+                };
+                nodes.push(para);
+                break;
+            }
+            case "text:h": {
+                const rawLevel = parseInt(child.attrs["text:outline-level"] ?? "1", 10);
+                const level = Math.min(Math.max(rawLevel, 1), 6);
+                const heading = {
+                    kind: "heading",
+                    level,
+                    spans: parseSpans(child, styles.charStyles),
+                };
+                nodes.push(heading);
+                break;
+            }
+            case "text:list":
+                nodes.push(parseList(child, styles));
+                break;
+            case "table:table":
+                nodes.push(parseTable(child, styles));
+                break;
+            case "text:section":
+                // Sections are transparent containers — recurse into their content
+                nodes.push(...parseBodyNodes(child, styles));
+                break;
+        }
+    }
+    return nodes;
+}
+// ============================================================
+// Metadata parser (exported for unit testing)
+// ============================================================
+/**
+ * Parse a meta.xml string and return the document metadata.
+ *
+ * Exported so it can be tested in isolation with known XML strings
+ * without needing a full .odt ZIP file.
+ *
+ * @param metaXml - Content of meta.xml as a string.
+ * @returns Populated OdtMetadata object. Missing fields are undefined.
+ */
+export function parseMetaXml(metaXml) {
+    const root = parseXml(metaXml);
+    const metaEl = findElement(root, "office:meta");
+    if (!metaEl)
+        return {};
+    const metadata = {};
+    const titleEl = findElement(metaEl, "dc:title");
+    if (titleEl)
+        metadata.title = textContent(titleEl);
+    const creatorEl = findElement(metaEl, "dc:creator");
+    if (creatorEl)
+        metadata.creator = textContent(creatorEl);
+    const descEl = findElement(metaEl, "dc:description");
+    if (descEl)
+        metadata.description = textContent(descEl);
+    const creationEl = findElement(metaEl, "meta:creation-date");
+    if (creationEl)
+        metadata.creationDate = textContent(creationEl);
+    const modEl = findElement(metaEl, "dc:date");
+    if (modEl)
+        metadata.modificationDate = textContent(modEl);
+    return metadata;
+}
+// ============================================================
+// Public API
+// ============================================================
+/**
+ * Parse an .odt file and return a structured document model.
+ *
+ * Reads content.xml for the document body and automatic styles, and
+ * meta.xml for document metadata. Both files are always present in
+ * spec-compliant .odt files.
+ *
+ * @param bytes - The raw .odt file as a Uint8Array.
+ * @returns A populated OdtDocumentModel with body, metadata, and toHtml().
+ * @throws Error if the input is not a valid ZIP or is missing content.xml.
+ *
+ * @example
+ * ```typescript
+ * import { readOdt } from "odf-kit/reader";
+ * import { readFileSync } from "node:fs";
+ *
+ * const bytes = new Uint8Array(readFileSync("document.odt"));
+ * const doc = readOdt(bytes);
+ * console.log(doc.body.length, "body nodes");
+ * ```
+ */
+export function readOdt(bytes) {
+    const zip = unzipSync(bytes);
+    const contentXmlBytes = zip["content.xml"];
+    if (!contentXmlBytes)
+        throw new Error("readOdt: content.xml not found in ODT file");
+    const contentXml = strFromU8(contentXmlBytes);
+    const metaXmlBytes = zip["meta.xml"];
+    const metadata = metaXmlBytes ? parseMetaXml(strFromU8(metaXmlBytes)) : {};
+    const contentRoot = parseXml(contentXml);
+    const styles = buildStyleMaps(contentRoot);
+    const bodyEl = findElement(contentRoot, "office:body");
+    const bodyTextEl = bodyEl ? findElement(bodyEl, "office:text") : undefined;
+    const body = bodyTextEl ? parseBodyNodes(bodyTextEl, styles) : [];
+    return {
+        metadata,
+        body,
+        toHtml(options) {
+            return renderHtml(body, options);
+        },
+    };
+}
+//# sourceMappingURL=parser.js.map

package/dist/reader/parser.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/reader/parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAgBhD,+DAA+D;AAC/D,kCAAkC;AAClC,+DAA+D;AAE/D,8EAA8E;AAC9E,SAAS,WAAW,CAAC,IAAoB,EAAE,GAAW;IACpD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,KAAK,GAAG;YAAE,OAAO,KAAK,CAAC;IAClE,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,wEAAwE;AACxE,SAAS,WAAW,CAAC,IAAoB;IACvC,OAAO,IAAI,CAAC,QAAQ;SACjB,MAAM,CAAC,CAAC,CAAC,EAA2C,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC;SACzE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SAClB,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAmBD;;;;;;;GAOG;AACH,SAAS,UAAU,CAAC,IAAe,EAAE,QAAmB;IACtD,MAAM,MAAM,GAAc,EAAE,CAAC;IAC7B,IAAI,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI;QAAE,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;IACnD,IAAI,IAAI,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM;QAAE,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IACzD,IAAI,IAAI,CAAC,SAAS,IAAI,QAAQ,CAAC,SAAS;QAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAClE,IAAI,IAAI,CAAC,aAAa,IAAI,QAAQ,CAAC,aAAa;QAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAC9E,IAAI,IAAI,CAAC,WAAW,IAAI,QAAQ,CAAC,WAAW;QAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;IACxE,IAAI,IAAI,CAAC,SAAS,IAAI,QAAQ,CAAC,SAAS;QAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAClE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,qFAAqF;AACrF,SAAS,QAAQ,CAAC,IAAY,EAAE,KAAgB,EAAE,IAAa;IAC7D,MAAM,IAAI,GAAa,EAAE,IAAI,EAAE,CAAC;IAChC,IAAI,KAAK,CAAC,IAAI;QAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACjC,IAAI,KAAK,CAAC,MAAM;QAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACrC,IAAI,KAAK,CAAC,SAAS;QAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC3C,IAAI,KAAK,CAAC,aAAa;QAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;IACnD,IAAI,KAAK,CAAC,WAAW;QAAE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC/C,IAAI,KAAK,CAAC,SAAS;QAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IAC3C,IAAI,IAAI,KAAK,SAAS;QAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACzC,OAAO,IAAI,CAAC;AACd,CAAC;AAiBD;;;GAGG;AACH,SAAS,iBAAiB,CACxB,SAAyB,EACzB,UAAkC,EAClC,WAAiC;IAEjC,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;QACvC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,SAAS;QAEvC,IAAI,KAAK,CAAC,GAAG,KAAK,aAAa,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACvC,IAAI,CAAC,IAAI;gBAAE,SAAS;YAEpB,MAAM,WAAW,GAAG,WAAW,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;YAChE,IAAI,CAAC,WAAW;gBAAE,SAAS;YAE3B,MAAM,KAAK,GAAc,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC;YAE5B,IAAI,CAAC,CAAC,gBAAgB,CAAC,KAAK,MAAM;gBAAE,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;YACtD,IAAI,CAAC,CAAC,eAAe,CAAC,KAAK,QAAQ;gBAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;YAEzD,MAAM,cAAc,GAAG,CAAC,CAAC,4BAA4B,CAAC,CAAC;YACvD,IAAI,cAAc,KAAK,SAAS,IAAI,cAAc,KAAK,MAAM;gBAAE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC;YAEtF,MAAM,WAAW,GAAG,CAAC,CAAC,+BAA+B,CAAC,CAAC;YACvD,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,KAAK,MAAM;gBAAE,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;YAEpF,MAAM,YAAY,GAAG,CAAC,CAAC,qBAAqB,CAAC,CAAC;YAC9C,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAC/B,IAAI,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC;oBAAE,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC;gBAC/D,IAAI,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC;oBAAE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC;YAC7D,CAAC;YAED,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,IAAI,KAAK,CAAC,GAAG,KAAK,iBAAiB,EAAE,CAAC;YACpC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACvC,IAAI,CAAC,IAAI;gBAAE,SAAS;YAEpB,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACxC,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS;oBAAE,SAAS;gBAC5C,IAAI,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,GAAG;oBAAE,SAAS;gBACrD,IAAI,UAAU,CAAC,GAAG,KAAK,8BAA8B,EAAE,CAAC;oBACtD,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC9B,CAAC;qBAAM,IAAI,UAAU,CAAC,GAAG,KAAK,8BAA8B,EAAE,CAAC;oBAC7D,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,cAAc,CAAC,WAA2B;IACjD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAqB,CAAC;IAChD,MAAM,WAAW,GAAG,IAAI,GAAG,EAAmB,CAAC;IAE/C,MAAM,YAAY,GAAG,WAAW,CAAC,WAAW,EAAE,yBAAyB,CAAC,CAAC;IACzE,IAAI,YAAY;QAAE,iBAAiB,CAAC,YAAY,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IAE3E,MAAM,aAAa,GAAG,WAAW,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IAChE,IAAI,aAAa;QAAE,iBAAiB,CAAC,aAAa,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IAE7E,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;AACrC,CAAC;AAED,+DAA+D;AAC/D,sBAAsB;AACtB,+DAA+D;AAE/D;;;;;;;;;;;GAWG;AACH,SAAS,UAAU,CACjB,IAAoB,EACpB,UAAkC,EAClC,YAAuB,EAAE,EACzB,IAAa;IAEb,MAAM,KAAK,GAAe,EAAE,CAAC;IAE7B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC1B,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;YACpD,CAAC;YACD,SAAS;QACX,CAAC;QAED,QAAQ,KAAK,CAAC,GAAG,EAAE,CAAC;YAClB,KAAK,iBAAiB;gBACpB,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC1C,MAAM;YAER,KAAK,UAAU;gBACb,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;gBAC5C,MAAM;YAER,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,gEAAgE;gBAChE,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;gBACzD,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;gBACzD,MAAM;YACR,CAAC;YAED,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;gBACjD,MAAM,SAAS,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnF,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;gBAChD,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;gBAC3D,MAAM;YACR,CAAC;YAED,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC;gBACpD,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;gBACnE,MAAM;YACR,CAAC;YAED;gBACE,gEAAgE;gBAChE,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;gBAC9D,MAAM;QACV,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,+DAA+D;AAC/D,oBAAoB;AACpB,+DAA+D;AAE/D,mDAAmD;AACnD,SAAS,SAAS,CAAC,MAAsB,EAAE,MAAiB;IAC1D,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;IACxD,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC;IAE3D,MAAM,KAAK,GAAmB,EAAE,CAAC;IAEjC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,KAAK,gBAAgB;YAAE,SAAS;QAEzE,IAAI,KAAK,GAAe,EAAE,CAAC;QAC3B,IAAI,MAA4B,CAAC;QAEjC,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACvC,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS;gBAAE,SAAS;YAC3C,IAAI,SAAS,CAAC,GAAG,KAAK,QAAQ,IAAI,SAAS,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC7D,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;YACjE,CAAC;iBAAM,IAAI,SAAS,CAAC,GAAG,KAAK,WAAW,EAAE,CAAC;gBACzC,MAAM,GAAG,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;QAED,MAAM,IAAI,GAAiB,EAAE,KAAK,EAAE,CAAC;QACrC,IAAI,MAAM,KAAK,SAAS;YAAE,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC;QACjD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC1C,CAAC;AAED,sDAAsD;AACtD,SAAS,UAAU,CAAC,OAAuB,EAAE,MAAiB;IAC5D,MAAM,IAAI,GAAmB,EAAE,CAAC;IAEhC,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,KAAK,iBAAiB;YAAE,SAAS;QAE1E,MAAM,KAAK,GAAoB,EAAE,CAAC;QAElC,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACpC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;gBAAE,SAAS;YACxC,mEAAmE;YACnE,IAAI,MAAM,CAAC,GAAG,KAAK,0BAA0B;gBAAE,SAAS;YACxD,IAAI,MAAM,CAAC,GAAG,KAAK,kBAAkB;gBAAE,SAAS;YAEhD,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;YAClF,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;YAE/E,kEAAkE;YAClE,kEAAkE;YAClE,oCAAoC;YACpC,IAAI,KAAK,GAAe,EAAE,CAAC;YAC3B,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACxC,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,SAAS,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;oBAC/D,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;gBACjE,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GAAkB,EAAE,KAAK,EAAE,CAAC;YACtC,IAAI,OAAO,GAAG,CAAC;gBAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACxC,IAAI,OAAO,GAAG,CAAC;gBAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACxC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACvB,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,UAA0B,EAAE,MAAiB;IACnE,MAAM,KAAK,GAAe,EAAE,CAAC;IAE7B,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;QACxC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,SAAS;QAEvC,QAAQ,KAAK,CAAC,GAAG,EAAE,CAAC;YAClB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,IAAI,GAAkB;oBAC1B,IAAI,EAAE,WAAW;oBACjB,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC;iBAC5C,CAAC;gBACF,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACjB,MAAM;YACR,CAAC;YAED,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,oBAAoB,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;gBACxE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,CAA0B,CAAC;gBAC1E,MAAM,OAAO,GAAgB;oBAC3B,IAAI,EAAE,SAAS;oBACf,KAAK;oBACL,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC;iBAC5C,CAAC;gBACF,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACpB,MAAM;YACR,CAAC;YAED,KAAK,WAAW;gBACd,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;gBACrC,MAAM;YAER,KAAK,aAAa;gBAChB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;gBACtC,MAAM;YAER,KAAK,cAAc;gBACjB,mEAAmE;gBACnE,KAAK,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC7C,MAAM;QACV,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,+DAA+D;AAC/D,8CAA8C;AAC9C,+DAA+D;AAE/D;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC/B,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAChD,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAEvB,MAAM,QAAQ,GAAgB,EAAE,CAAC;IAEjC,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAChD,IAAI,OAAO;QAAE,QAAQ,CAAC,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAEnD,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACpD,IAAI,SAAS;QAAE,QAAQ,CAAC,OAAO,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IAEzD,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IACrD,IAAI,MAAM;QAAE,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAEvD,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAC7D,IAAI,UAAU;QAAE,QAAQ,CAAC,YAAY,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;IAEhE,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC7C,IAAI,KAAK;QAAE,QAAQ,CAAC,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAE1D,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,+DAA+D;AAC/D,aAAa;AACb,+DAA+D;AAE/D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,OAAO,CAAC,KAAiB;IACvC,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IAE7B,MAAM,eAAe,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC;IAC3C,IAAI,CAAC,eAAe;QAAE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IACpF,MAAM,UAAU,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;IAE9C,MAAM,YAAY,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAgB,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAExF,MAAM,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAE3C,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IACvD,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3E,MAAM,IAAI,GAAe,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAE9E,OAAO;QACL,QAAQ;QACR,IAAI;QACJ,MAAM,CAAC,OAAqB;YAC1B,OAAO,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/reader/types.d.ts ADDED Viewed

@@ -0,0 +1,139 @@
+/**
+ * Document model types for the odf-kit ODT reader.
+ *
+ * These interfaces describe the intermediate representation produced by
+ * readOdt() — a typed, traversable document model that maps ODF structure
+ * to familiar concepts without exposing any ODF XML details.
+ *
+ * The model is intentionally simple for Tier 1: paragraphs, headings,
+ * lists, and tables, each carrying one or more TextSpan objects for
+ * inline content. Tier 2 will extend the model with styled output
+ * (fonts, colors, margins) and embedded images.
+ */
+/**
+ * A single run of inline content with optional character formatting.
+ *
+ * A paragraph or heading is made up of one or more TextSpan objects.
+ * Adjacent runs with different formatting are kept separate. A span
+ * with lineBreak set to true represents a <text:line-break/> element
+ * and carries an empty text string.
+ */
+export interface TextSpan {
+    /** The text content of this run. Empty string when lineBreak is true. */
+    text: string;
+    /** When true, this run represents a hard line break (<br> in HTML). */
+    lineBreak?: true;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    strikethrough?: boolean;
+    superscript?: boolean;
+    subscript?: boolean;
+    /** The href value when this run is part of a hyperlink. */
+    href?: string;
+}
+/** A paragraph in the document body. */
+export interface ParagraphNode {
+    kind: "paragraph";
+    spans: TextSpan[];
+}
+/** A heading in the document body at the given outline level. */
+export interface HeadingNode {
+    kind: "heading";
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+    spans: TextSpan[];
+}
+/**
+ * A list item. May contain a nested child list for multi-level lists.
+ */
+export interface ListItemNode {
+    spans: TextSpan[];
+    children?: ListNode;
+}
+/** An ordered or unordered list. */
+export interface ListNode {
+    kind: "list";
+    ordered: boolean;
+    items: ListItemNode[];
+}
+/**
+ * A single table cell. colSpan and rowSpan are only present when
+ * the cell spans more than one column or row.
+ */
+export interface TableCellNode {
+    spans: TextSpan[];
+    colSpan?: number;
+    rowSpan?: number;
+}
+/** A table row. */
+export interface TableRowNode {
+    cells: TableCellNode[];
+}
+/** A table. */
+export interface TableNode {
+    kind: "table";
+    rows: TableRowNode[];
+}
+/**
+ * Discriminated union of all node types that can appear in the
+ * document body. Use the kind property to narrow to a specific type.
+ */
+export type BodyNode = ParagraphNode | HeadingNode | ListNode | TableNode;
+/** Document metadata extracted from meta.xml. */
+export interface OdtMetadata {
+    title?: string;
+    creator?: string;
+    description?: string;
+    /** ISO 8601 date string from meta:creation-date. */
+    creationDate?: string;
+    /** ISO 8601 date string from dc:date (last modified). */
+    modificationDate?: string;
+}
+/** Options for HTML conversion. */
+export interface HtmlOptions {
+    /**
+     * When true, omit the <!DOCTYPE html><html><body> wrapper and return
+     * only the inner HTML fragment. Useful for embedding in an existing page.
+     * Default: false.
+     */
+    fragment?: boolean;
+}
+/**
+ * The parsed ODT document returned by readOdt().
+ *
+ * Provides typed access to the document body and metadata, plus a
+ * convenience method for HTML conversion.
+ *
+ * @example
+ * ```typescript
+ * import { readOdt } from "odf-kit/reader";
+ * import { readFileSync } from "node:fs";
+ *
+ * const bytes = new Uint8Array(readFileSync("document.odt"));
+ * const doc = readOdt(bytes);
+ * console.log(doc.metadata.title);
+ * const html = doc.toHtml({ fragment: true });
+ * ```
+ */
+export interface OdtDocumentModel {
+    /** Document metadata from meta.xml. */
+    readonly metadata: OdtMetadata;
+    /**
+     * Ordered list of body nodes: paragraphs, headings, lists, and tables
+     * in document order.
+     */
+    readonly body: BodyNode[];
+    /**
+     * Convert the document to an HTML string.
+     *
+     * @param options - HTML output options.
+     * @returns HTML string representation of the document.
+     *
+     * @example
+     * ```typescript
+     * const html = doc.toHtml({ fragment: true });
+     * ```
+     */
+    toHtml(options?: HtmlOptions): string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/reader/types.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/reader/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACvB,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC;IACb,uEAAuE;IACvE,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,wCAAwC;AACxC,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED,iEAAiE;AACjE,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,oCAAoC;AACpC,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,mBAAmB;AACnB,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,aAAa,EAAE,CAAC;CACxB;AAED,eAAe;AACf,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,YAAY,EAAE,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE1E,iDAAiD;AACjD,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,mCAAmC;AACnC,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,MAAM,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;CACvC"}

package/dist/reader/types.js ADDED Viewed

@@ -0,0 +1,14 @@
+/**
+ * Document model types for the odf-kit ODT reader.
+ *
+ * These interfaces describe the intermediate representation produced by
+ * readOdt() — a typed, traversable document model that maps ODF structure
+ * to familiar concepts without exposing any ODF XML details.
+ *
+ * The model is intentionally simple for Tier 1: paragraphs, headings,
+ * lists, and tables, each carrying one or more TextSpan objects for
+ * inline content. Tier 2 will extend the model with styled output
+ * (fonts, colors, margins) and embedded images.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/reader/types.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/reader/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG"}

package/dist/reader/xml-parser.d.ts ADDED Viewed

@@ -0,0 +1,45 @@
+/**
+ * Minimal XML parser for ODF content.xml and meta.xml.
+ *
+ * ODF files always contain well-formed XML, which allows a straightforward
+ * single-pass parser rather than a full spec-compliant implementation.
+ * The parser handles all constructs present in ODF XML: elements, text
+ * nodes, attributes, self-closing tags, XML declarations, and comments.
+ *
+ * The output is a lightweight element tree: each node is either an
+ * XmlElementNode (tag, attributes, children) or an XmlTextNode (text
+ * content). XML entities in both text nodes and attribute values are
+ * decoded to their character equivalents so callers work with plain
+ * strings throughout.
+ *
+ * Exported for unit testing and for use by the ODT parser.
+ */
+/** An element node in the XML tree. */
+export interface XmlElementNode {
+    type: "element";
+    /** The fully-qualified tag name including namespace prefix, e.g. "text:p". */
+    tag: string;
+    /** Attribute map. Keys include namespace prefix, e.g. "text:style-name". */
+    attrs: Record<string, string>;
+    children: XmlNode[];
+}
+/** A text node in the XML tree. XML entities are decoded. */
+export interface XmlTextNode {
+    type: "text";
+    text: string;
+}
+/** A node in the XML tree. */
+export type XmlNode = XmlElementNode | XmlTextNode;
+/**
+ * Parse an ODF XML string into an element tree.
+ *
+ * Returns the root element of the document. Skips XML declarations
+ * (<?xml ...?>), processing instructions, and comments. Assumes
+ * well-formed XML — ODF files produced by conformant writers always are.
+ *
+ * @param xml - XML string, optionally starting with a UTF-8 BOM.
+ * @returns The root XmlElementNode.
+ * @throws Error if the input contains no root element.
+ */
+export declare function parseXml(xml: string): XmlElementNode;
+//# sourceMappingURL=xml-parser.d.ts.map

package/dist/reader/xml-parser.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"xml-parser.d.ts","sourceRoot":"","sources":["../../src/reader/xml-parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,uCAAuC;AACvC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,SAAS,CAAC;IAChB,8EAA8E;IAC9E,GAAG,EAAE,MAAM,CAAC;IACZ,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAED,6DAA6D;AAC7D,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,8BAA8B;AAC9B,MAAM,MAAM,OAAO,GAAG,cAAc,GAAG,WAAW,CAAC;AAoCnD;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CA6FpD"}

package/dist/reader/xml-parser.js ADDED Viewed

@@ -0,0 +1,146 @@
+/**
+ * Minimal XML parser for ODF content.xml and meta.xml.
+ *
+ * ODF files always contain well-formed XML, which allows a straightforward
+ * single-pass parser rather than a full spec-compliant implementation.
+ * The parser handles all constructs present in ODF XML: elements, text
+ * nodes, attributes, self-closing tags, XML declarations, and comments.
+ *
+ * The output is a lightweight element tree: each node is either an
+ * XmlElementNode (tag, attributes, children) or an XmlTextNode (text
+ * content). XML entities in both text nodes and attribute values are
+ * decoded to their character equivalents so callers work with plain
+ * strings throughout.
+ *
+ * Exported for unit testing and for use by the ODT parser.
+ */
+/**
+ * Decode the five standard XML predefined entities in a string.
+ *
+ * Applied to both text node content and attribute values so that callers
+ * always receive plain character strings, never entity references.
+ */
+function decodeEntities(raw) {
+    return raw
+        .replace(/&amp;/g, "&")
+        .replace(/&lt;/g, "<")
+        .replace(/&gt;/g, ">")
+        .replace(/&quot;/g, '"')
+        .replace(/&apos;/g, "'");
+}
+/**
+ * Parse attribute key="value" pairs from the inner content of an open tag.
+ *
+ * Handles namespace-prefixed names such as text:style-name and
+ * xlink:href. Attribute values are entity-decoded.
+ *
+ * @param raw - The portion of the tag string after the tag name.
+ * @returns Map of attribute name to decoded value.
+ */
+function parseAttributes(raw) {
+    const attrs = {};
+    const re = /([a-zA-Z_:][a-zA-Z0-9_:.-]*)="([^"]*)"/g;
+    let m;
+    while ((m = re.exec(raw)) !== null) {
+        attrs[m[1]] = decodeEntities(m[2]);
+    }
+    return attrs;
+}
+/**
+ * Parse an ODF XML string into an element tree.
+ *
+ * Returns the root element of the document. Skips XML declarations
+ * (<?xml ...?>), processing instructions, and comments. Assumes
+ * well-formed XML — ODF files produced by conformant writers always are.
+ *
+ * @param xml - XML string, optionally starting with a UTF-8 BOM.
+ * @returns The root XmlElementNode.
+ * @throws Error if the input contains no root element.
+ */
+export function parseXml(xml) {
+    // Strip UTF-8 BOM if present
+    const src = xml.startsWith("\uFEFF") ? xml.slice(1) : xml;
+    const stack = [];
+    let root;
+    let i = 0;
+    while (i < src.length) {
+        if (src[i] !== "<") {
+            // Text node
+            const end = src.indexOf("<", i);
+            const raw = end === -1 ? src.slice(i) : src.slice(i, end);
+            i = end === -1 ? src.length : end;
+            if (raw.length > 0 && stack.length > 0) {
+                stack[stack.length - 1].children.push({ type: "text", text: decodeEntities(raw) });
+            }
+            continue;
+        }
+        // XML comment: <!-- ... -->
+        if (src.startsWith("<!--", i)) {
+            const end = src.indexOf("-->", i);
+            i = end === -1 ? src.length : end + 3;
+            continue;
+        }
+        // CDATA section: <![CDATA[ ... ]]>
+        if (src.startsWith("<![CDATA[", i)) {
+            const end = src.indexOf("]]>", i);
+            if (end !== -1) {
+                const text = src.slice(i + 9, end);
+                if (text.length > 0 && stack.length > 0) {
+                    stack[stack.length - 1].children.push({ type: "text", text });
+                }
+                i = end + 3;
+            }
+            else {
+                i = src.length;
+            }
+            continue;
+        }
+        // All other tags: find the closing >
+        const end = src.indexOf(">", i);
+        if (end === -1)
+            break; // malformed — stop
+        const inner = src.slice(i + 1, end);
+        i = end + 1;
+        // XML declaration or processing instruction: <?...?>
+        if (inner.startsWith("?"))
+            continue;
+        // DOCTYPE declaration
+        if (inner.startsWith("!"))
+            continue;
+        // Close tag: </tag>
+        if (inner.startsWith("/")) {
+            stack.pop();
+            continue;
+        }
+        // Self-closing tag: <tag attrs/>
+        if (inner.endsWith("/")) {
+            const body = inner.slice(0, -1).trimEnd();
+            const space = body.search(/\s/);
+            const tag = space === -1 ? body : body.slice(0, space);
+            const attrs = space === -1 ? {} : parseAttributes(body.slice(space + 1));
+            const node = { type: "element", tag, attrs, children: [] };
+            if (stack.length > 0) {
+                stack[stack.length - 1].children.push(node);
+            }
+            else if (!root) {
+                root = node;
+            }
+            continue;
+        }
+        // Open tag: <tag attrs>
+        const space = inner.search(/\s/);
+        const tag = space === -1 ? inner : inner.slice(0, space);
+        const attrs = space === -1 ? {} : parseAttributes(inner.slice(space + 1));
+        const node = { type: "element", tag, attrs, children: [] };
+        if (stack.length > 0) {
+            stack[stack.length - 1].children.push(node);
+        }
+        stack.push(node);
+        if (!root)
+            root = node;
+    }
+    if (!root)
+        throw new Error("parseXml: no root element found");
+    return root;
+}
+//# sourceMappingURL=xml-parser.js.map

package/dist/reader/xml-parser.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"xml-parser.js","sourceRoot":"","sources":["../../src/reader/xml-parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAqBH;;;;;GAKG;AACH,SAAS,cAAc,CAAC,GAAW;IACjC,OAAO,GAAG;SACP,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;SACtB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;SACrB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,eAAe,CAAC,GAAW;IAClC,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,MAAM,EAAE,GAAG,yCAAyC,CAAC;IACrD,IAAI,CAAC,CAAC;IACN,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QACnC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAW;IAClC,6BAA6B;IAC7B,MAAM,GAAG,GAAG,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAE1D,MAAM,KAAK,GAAqB,EAAE,CAAC;IACnC,IAAI,IAAgC,CAAC;IACrC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEV,OAAO,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;QACtB,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACnB,YAAY;YACZ,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAChC,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC1D,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;YAClC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACrF,CAAC;YACD,SAAS;QACX,CAAC;QAED,4BAA4B;QAC5B,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC;YAC9B,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAClC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;YACtC,SAAS;QACX,CAAC;QAED,mCAAmC;QACnC,IAAI,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC;YACnC,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAClC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;gBACf,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;gBACnC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACxC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBAChE,CAAC;gBACD,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC;YACjB,CAAC;YACD,SAAS;QACX,CAAC;QAED,qCAAqC;QACrC,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAChC,IAAI,GAAG,KAAK,CAAC,CAAC;YAAE,MAAM,CAAC,mBAAmB;QAE1C,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;QACpC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC;QAEZ,qDAAqD;QACrD,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS;QAEpC,sBAAsB;QACtB,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS;QAEpC,oBAAoB;QACpB,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,KAAK,CAAC,GAAG,EAAE,CAAC;YACZ,SAAS;QACX,CAAC;QAED,iCAAiC;QACjC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAChC,MAAM,GAAG,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YACvD,MAAM,KAAK,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;YACzE,MAAM,IAAI,GAAmB,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;YAC3E,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrB,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,CAAC;iBAAM,IAAI,CAAC,IAAI,EAAE,CAAC;gBACjB,IAAI,GAAG,IAAI,CAAC;YACd,CAAC;YACD,SAAS;QACX,CAAC;QAED,wBAAwB;QACxB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,GAAG,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1E,MAAM,IAAI,GAAmB,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAE3E,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEjB,IAAI,CAAC,IAAI;YAAE,IAAI,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAC9D,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json CHANGED Viewed

@@ -1,61 +1,65 @@
-{
-  "name": "odf-kit",
-  "version": "0.4.0",
-  "description": "Create OpenDocument Format files (.odt, .ods, .odp, .odg) in TypeScript/JavaScript. Works in Node.js and browsers.",
-  "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist",
-    "LICENSE",
-    "README.md",
-    "CHANGELOG.md"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
-    "lint": "eslint src tests",
-    "format": "prettier --write src tests",
-    "format:check": "prettier --check src tests",
-    "clean": "node -e \"const fs=require('fs');fs.rmSync('dist',{recursive:true,force:true})\"",
-    "prepublishOnly": "npm run clean && npm run build"
-  },
-  "keywords": [
-    "odf",
-    "opendocument",
-    "odt",
-    "ods",
-    "odp",
-    "odg",
-    "libreoffice",
-    "document",
-    "spreadsheet",
-    "presentation",
-    "browser"
-  ],
-  "author": "GitHubNewbie0",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/GitHubNewbie0/odf-kit.git"
-  },
-  "dependencies": {
-    "fflate": "^0.8.2"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.18.0",
-    "@types/jest": "^29.5.14",
-    "eslint": "^9.18.0",
-    "jest": "^29.7.0",
-    "prettier": "^3.4.2",
-    "ts-jest": "^29.2.5",
-    "typescript": "^5.7.3",
-    "typescript-eslint": "^8.21.0"
-  }
-}
+{
+  "name": "odf-kit",
+  "version": "0.5.0",
+  "description": "Create OpenDocument Format files (.odt, .ods, .odp, .odg) in TypeScript/JavaScript. Works in Node.js and browsers.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./reader": {
+      "types": "./dist/reader/index.d.ts",
+      "import": "./dist/reader/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "lint": "eslint src tests",
+    "format": "prettier --write src tests",
+    "format:check": "prettier --check src tests",
+    "clean": "node -e \"const fs=require('fs');fs.rmSync('dist',{recursive:true,force:true})\"",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "keywords": [
+    "odf",
+    "opendocument",
+    "odt",
+    "ods",
+    "odp",
+    "odg",
+    "libreoffice",
+    "document",
+    "spreadsheet",
+    "presentation",
+    "browser"
+  ],
+  "author": "GitHubNewbie0",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GitHubNewbie0/odf-kit.git"
+  },
+  "dependencies": {
+    "fflate": "^0.8.2"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.18.0",
+    "@types/jest": "^29.5.14",
+    "eslint": "^9.18.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.4.2",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.21.0"
+  }
+}