officeparser 6.1.0 → 6.1.1

package/README.md

@@ -23,44 +23,12 @@ A robust, strictly-typed Node.js and Browser library for parsing office files ([
 ---
 
 
-#### Update
-* 2026-04-14 - **v6.1.0 Release**: Major Infrastructure & Resource Stability. (Incremental since v6.0.0)
-    - **OCR Scheduler**: Intelligent worker pool that optimizes Tesseract lifecycle across parallel requests. **Note**: By default, Node.js processes stay active for 10s after OCR to keep workers warm (configurable via `ocrConfig.autoTerminateTimeout`); use `terminateOcr()` for immediate CLI/script exit.
-    - **Core Engine**: Replaced legacy zip extraction with `fflate` for significant performance gains and robust browser/edge compatibility.
-    - **Module System**: Full native ESM support with `Node16` resolution and verified browser bundles (Vite/Angular compatible).
-    - **Format Refinements**: Hierarchical PDF coordinate alignment and ODT/RTF list parsing stability.
-    - **Custom Properties**: Added support for extracting custom document metadata across OOXML, ODF, and PDF formats.
-    - **Sponsorship**: Integrated `funding.json` manifest and GitHub Sponsors support.
-* 2025/12/29 - **v6.0.0 Release**: Major overhaul of the library. Transitioned from simple text extraction to a rich **Abstract Syntax Tree (AST)** output.
-    - Simplified API: Use `parseOffice` for all parsing needs (returns a Promise).
-    - Structured Output: Access hierarchical document structure (paragraphs, headings, tables, lists, etc.).
-    - Rich Metadata: Extracted document properties (author, title, creation date).
-    - Enhanced Formatting: Support for bold, italic, colors, fonts, alignment, etc.
-    - Attachment Handling: Extract images, charts, and embedded files as Base64.
-    - OCR Integration: Optional OCR for images using Tesseract.js.
-    - RTF Support: Added full support for Rich Text Format files.
-    - Improved Type Definitions: Full TypeScript support with detailed interfaces.
-* 2024/11/12 - Added ArrayBuffer as a type of file input. Generating bundle files now which exposes namespace officeParser to be able to access parseOffice directly on the browser.
-* 2024/10/21 - Replaced extracting zip files from decompress to yauzl. This means that we now extract files in memory and we no longer need to write them to disk. Removed config flags related to extracted files. Added flags for CLI execution.
-* 2024/10/15 - Fixed erroring out while deleting temp files when multiple worker threads make parallel executions resulting in same file name for multiple files. Fixed erroring out when multiple executions are made without waiting for the previous execution to finish which resulted in deleting the file from other execution. Upgraded dependencies.
-* 2024/10/13 - Fixed parsing text from xlsx files which contain no shared strings file and files which have inlineStr based strings.
-* 2024/05/06 - Replaced pdf parsing support from pdf-parse library to natively building it using pdf.js library from Mozilla by analyzing its output. Added pdfjs-dist build as a local library.
-* 2023/11/25 - Fixed error catching when an error occurs within the parsing of a file, especially after decompressing it. Also fixed the problem with parallel parsing of files as we were using only timestamp in file names.
-* 2023/10/24 - Revamped content parsing code. Fixed order of content in files, especially in word files where table information would always land up at the end of the text. Added config object as argument for parseOffice which can be used to set new line delimiter and multiple other configurations. Added support for parsing pdf files using the popular npm library pdf-parse. Removed support for individual file parsing functions.
-* 2023/04/26 - Added support for file buffers as argument for filepath for parseOffice and parseOfficeAsync
-* 2023/04/07 - Added typings to methods to help with Typescript projects.
-* 2022/12/28 - Added command line method to use officeParser with or without installing it and instantly get parsed content on the console.
-* 2022/12/10 - Fixed memory leak issues, bugs related to parsing open document files and improved error handling.
-* 2021/11/21 - Added promise way to existing callback functions.
-* 2020/06/01 - Added error handling and console.log enable/disable methods. Default is set at enabled. Everything backward compatible.
-* 2019/06/17 - Added method to change location for decompressing office files in places with restricted write access.
-* 2019/04/30 - Removed case sensitive file extension bug. File names with capital lettered extensions now supported.
-* 2019/04/23 - Added support for open office files *.odt, *.odp, *.ods through parseOffice function. Created a new method parseOpenOffice for those who prefer targetted functions. 
-* 2019/04/23 - Added feature to delete the generated dist folder after function callback.
-* 2019/04/22 - Added parseOffice method to avoid confusion between type of file and their extension.
-* 2019/04/22 - Added file extension validations. Removed errors for excel files with no drawing elements.
-* 2019/04/19 - Support added for *.xlsx files.
-* 2019/04/18 - Support added for *.pptx files.
+---
+
+### 📝 [Changelog](CHANGELOG.md)
+*Detailed release notes and the full history of updates are available in the project changelog.*
+
+---
 
 ## Install via npm
 
@@ -91,6 +59,7 @@ npx officeparser /path/to/officeFile.docx --ignoreNotes=true --newlineDelimiter=
 - `--extractAttachments=[true|false]`   Flag to extract images/charts as Base64. Default is false.
 - `--ocr=[true|false]`                  Flag to enable OCR for extracted images. Default is false.
 - `--includeRawContent=[true|false]`    Flag to include raw XML/RTF content in nodes. Default is false.
+- `--includeBreakNodes=[true|false]`    Flag to include break nodes. Currently only available for DOCX documents
 - `--verbose=[true|false]`              Show full error stack traces.
 
 
@@ -131,7 +100,7 @@ console.log(text);
 ```
 
 ### Using Callbacks (Backward Compatibility Support)
-We still support callbacks, but the data returned is now the AST object.
+Callbacks are still supported for those preferred, but the data returned is now the AST object.
 ```js
 const officeParser = require('officeparser');
 
@@ -172,7 +141,7 @@ OfficeParserAST
 │   ├── text: "Concatenated text of this node and all children"
 │   ├── children: [ OfficeContentNode ] (recursive)
 │   ├── formatting: { bold, italic, color, size, font, ... }
-│   ├── metadata: { level, listId, row, col, ... }
+│   ├── metadata: { level, listId, paragraphIndentation, row, col, ... }
 │   └── rawContent: "<xml>...</xml>" (if enabled)
 ├── attachments: [ OfficeAttachment ]
 │   ├── type: "image" | "chart"
@@ -224,13 +193,15 @@ List Node
     listId: "1", 
     listType: "ordered", 
     indentation: 0, 
+    paragraphIndentation: { left: 720, hanging: 360 },
     itemIndex: 0 
 }
 └── children: [ Text Content... ]
 ```
 
 - **`listId`**: A unique identifier for the list definition. Multiple items with the same `listId` belong to the same logical list.
-- **`indentation`**: The nesting level (0-based).
+- **`indentation`**: The structural nesting level (0-based).
+- **`paragraphIndentation`**: The physical indentation formatting in twentieths of a point (twips) (e.g., `left`, `right`, `firstLine`, `hanging`).
 - **`itemIndex`**: The sequential position within that list level.
 - **`listType`**: Either `ordered` (numbered) or `unordered` (bulleted).
 
@@ -309,13 +280,31 @@ Formatting can be found at two levels:
 1.  **Node Level**: Applied directly to a text run or paragraph.
 2.  **Document Level**: Found in `ast.metadata.formatting` (defaults) or `ast.metadata.styleMap` (named styles).
 
-### 6. Advanced Metadata
+### 6. Breaks
+Breaks are currently only supported when parsing DOCX-documents. Breaks are added as a node of type `break` and carry metadata of the type `BreakMetadata`. When `includeRawContent` is enabled, they also include the `rawContent` string from the original XML.
+
+```text
+Break Node
+├── type: "break"
+└── metadata: {
+        breakType: "textWrapping" | "page" | "column" | "lastRenderedPage" | "carriageReturn",
+        clear?: "all" | "left" | "none" | "right"
+    }
+```
+
+- `breakType`: Type of break. `textWrapping` (default) is a standard line break, `page` is a page break, `column` is a break to the next column, `lastRenderedPage` is a soft break inserted by Word, and `carriageReturn` is an explicit carriage return (`w:cr`).
+- `clear`: Relevant for `textWrapping`. Indicates if text should wrap around floating objects.
+
+> [!NOTE]
+> Even though break nodes don't have a `text` property, the `ast.toText()` method will automatically convert them to newlines (`\n`) or the configured delimiter in the final string output.
+
+### 7. Advanced Metadata
 The `ast.metadata` object provides document-wide context:
 - **`styleMap`**: A dictionary of style names to their `TextFormatting` definitions found in the document.
 - **`formatting`**: Document-wide default settings (e.g., default font or font size).
 - **`customProperties`**: A dictionary of user-defined metadata embedded in the document (OOXML `custom.xml`, ODF `meta:user-defined`, or PDF Info dictionary).
 
-### 7. Custom Properties
+### 8. Custom Properties
 You can access custom user-defined metadata that might be embedded in the document:
 
 ```javascript
@@ -435,12 +424,13 @@ Pass an optional config object as the second argument to `parseOffice`.
 | `ocrConfig.workerPath` | string | `undefined` | Path to Tesseract worker script (for offline use). |
 | `ocrConfig.corePath` | string | `undefined` | Path to Tesseract core script (for offline use). |
 | `ocrConfig.langPath` | string | `undefined` | Path for Tesseract language files (for offline use). |
+| `includeBreakNodes` | boolean | `false` | Specifically targets Word documents (DOCX). When set to true, officeParser will also parse `w:br`, `w:cr` and `w:lastRenderedPageBreak` nodes.|
 
 ### OCR Scheduler & Resource Management
 If your application uses OCR, `officeParser` utilizes an intelligent **Smart Worker Pool** to maintain a background worker pool and optimize repeated parse requests.
 
 - **Dynamic Affinity**: Workers in the pool persist with their last used language affinity. 
-- **Smart Re-initialization**: If a new language is requested and the pool is full, the manager identifies the **Least Recently Used (LRU)** idle worker and re-initializes it for the new language using the Tesseract.js v5 API. This avoids the overhead of destroying and recreating workers.
+- **LRU Re-allocation**: If a new language is requested and the pool is full, the manager identifies the **Least Recently Used (LRU)** idle worker and re-initializes it for the new language. This avoids the overhead of destroying and recreating workers.
 - **Auto-Termination**: Workers are automatically cleaned up after 10 seconds of inactivity (configurable via `ocrConfig.autoTerminateTimeout`).
 
 #### `OfficeParser.terminateOcr()`
@@ -462,7 +452,7 @@ async function runCleaner() {
 ```
 
 > [!TIP]
-> This is handled automatically in our own CLI (`npx officeparser ...`). You only need to call this manually if you are using the library in your own custom script and want a snappy exit.
+> This is handled automatically in the built-in CLI (`npx officeparser ...`). You only need to call this manually if you are using the library in your own custom script and want a snappy exit.
 
 ```js
 const config = {
@@ -509,36 +499,51 @@ The library provides two types of browser bundles in the `dist/` directory:
 1. **`officeparser.browser.iife.js`**: Standard IIFE bundle for direct `<script>` tag usage. Exposes the global `officeParser` namespace.
 2. **`officeparser.browser.mjs`**: Modern ESM bundle for use with `import` statements or modern bundlers.
 
+### Usage (ESM)
+If you are using a modern bundler like **Vite**, **Webpack**, or **Next.js**:
+
+```javascript
+import { OfficeParser } from 'officeparser';
+
+const handleFile = async (event) => {
+    const file = event.target.files[0];
+    const buffer = await file.arrayBuffer();
+    
+    try {
+        // Pass the Buffer or Uint8Array directly
+        const ast = await OfficeParser.parseOffice(new Uint8Array(buffer));
+        console.log(ast.toText());
+    } catch (err) {
+        console.error(err);
+    }
+};
+```
+
+> [!NOTE] 
+> **Why `fs` fails in the browser**: Browsers do not have a built-in file system. If you try to pass a file path string in the browser, `officeParser` will throw a descriptive "Fail-Fast" error instead of crashing mysteriously: 
+> `[officeparser] Node.js 'fs' module is not available in the browser. Please pass a Buffer or Uint8Array instead.`
+
 ### Usage (Script Tag)
-Include the IIFE bundle file available in the release assets.
+Include the IIFE bundle available in the release assets or your `dist/` folder. This exposes the global `officeParser` object.
 
 ```html
 <script src="dist/officeparser.browser.iife.js"></script>
 <script>
-    async function handleFile(file) {
-        // file can be a File object from an input element or an ArrayBuffer
+    async function handleFile(event) {
+        const file = event.target.files[0];
+        const buffer = await file.arrayBuffer();
+        
         try {
-            const ast = await officeParser.parseOffice(file, { ocr: true });
+            // Reconstruct as Uint8Array for the parser
+            const ast = await officeParser.parseOffice(new Uint8Array(buffer));
             console.log(ast.toText());
         } catch (error) {
-            console.error(error);
+            console.error("Parsing failed:", error);
         }
     }
 </script>
 ```
 
-### Usage (ESM)
-If you are using a modern browser that supports modules or a dev server like Vite:
-
-```html
-<script type="module">
-    import { OfficeParser } from './dist/officeparser.browser.mjs';
-    
-    const ast = await OfficeParser.parseOffice(fileBuffer);
-    console.log(ast.metadata);
-</script>
-```
-
 ### PDF Worker Configuration in Browser
 When using `officeparser` in a browser environment to parse PDF files, you may provide the `pdfWorkerSrc` configuration option. If not provided, it defaults to a CDN link for `pdfjs-dist@5.6.205`.
 
@@ -579,7 +584,7 @@ For a comprehensive guide, visit our [Debugging & Troubleshooting Documentation]
 
 ## Contributing
 
-We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started.
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started.
 
 ## License
 

package/dist/OfficeParser.js

@@ -120,6 +120,7 @@ class OfficeParser {
             preserveXmlWhitespace: false,
             pdfWorkerSrc: '',
             ocrConfig: {},
+            includeBreakNodes: false,
             ...actualConfig
         };
         let buffer = Buffer.alloc(0);

package/dist/cli.js

@@ -106,6 +106,7 @@ else {
     console.log('  --includeRawContent=true     Include raw content in AST');
     console.log('  --serializeRawContent=true   Serialize raw XML content (default: true)');
     console.log('  --preserveXmlWhitespace=true Preserve whitespace in serialized XML (default: false)');
+    console.log('  --includeBreakNodes=false    Include break nodes (DOCX only, default: false)');
     console.log('  --verbose=true               Show full error stack traces');
     console.log('');
     console.log('Examples:');

package/dist/index.d.ts

@@ -44,8 +44,8 @@
  * @module officeparser
  */
 import { OfficeParser } from './OfficeParser.js';
-import { OfficeParserConfig, OfficeParserAST, OfficeContentNode, OfficeAttachment, OfficeMetadata, TextFormatting, SupportedFileType, OfficeContentNodeType, OfficeMimeType, SlideMetadata, SheetMetadata, HeadingMetadata, ListMetadata, CellMetadata, ImageMetadata, PageMetadata, ContentMetadata } from './types';
+import { OfficeParserConfig, OfficeParserAST, OfficeContentNode, OfficeAttachment, OfficeMetadata, TextFormatting, SupportedFileType, OfficeContentNodeType, OfficeMimeType, SlideMetadata, SheetMetadata, HeadingMetadata, ListMetadata, CellMetadata, ImageMetadata, PageMetadata, ContentMetadata, BreakMetadata } from './types';
 declare const parseOffice: typeof OfficeParser.parseOffice;
 declare const terminateOcr: typeof OfficeParser.terminateOcr;
-export { OfficeParser, parseOffice, terminateOcr, OfficeParserConfig, OfficeParserAST, OfficeContentNode, OfficeAttachment, OfficeMetadata, TextFormatting, SupportedFileType, OfficeContentNodeType, OfficeMimeType, SlideMetadata, SheetMetadata, HeadingMetadata, ListMetadata, CellMetadata, ImageMetadata, PageMetadata, ContentMetadata };
+export { OfficeParser, parseOffice, terminateOcr, OfficeParserConfig, OfficeParserAST, OfficeContentNode, OfficeAttachment, OfficeMetadata, TextFormatting, SupportedFileType, OfficeContentNodeType, OfficeMimeType, SlideMetadata, SheetMetadata, HeadingMetadata, ListMetadata, CellMetadata, ImageMetadata, PageMetadata, ContentMetadata, BreakMetadata, };
 export default OfficeParser;

package/dist/officeparser.browser.d.ts

@@ -118,6 +118,13 @@ export interface OfficeParserConfig {
 	 * You can override this with your own local path or a different CDN link.
 	 */
 	pdfWorkerSrc?: string;
+	/**
+	 * Flag to include break nodes in the AST.
+	 * This is currently only supported for Word documents. (w:br nodes)
+	 *
+	 * Default is false
+	 */
+	includeBreakNodes?: boolean;
 }
 /**
  * Supported file types for parsing.
@@ -126,7 +133,7 @@ export type SupportedFileType = "docx" | "pptx" | "xlsx" | "odt" | "odp" | "ods"
 /**
  * Types of content nodes in the AST.
  */
-export type OfficeContentNodeType = "paragraph" | "heading" | "table" | "list" | "text" | "image" | "chart" | "drawing" | "slide" | "note" | "sheet" | "row" | "cell" | "page";
+export type OfficeContentNodeType = "paragraph" | "heading" | "table" | "list" | "text" | "image" | "chart" | "drawing" | "slide" | "note" | "sheet" | "row" | "cell" | "page" | "break";
 /**
  * Supported MIME types for attachments.
  */
@@ -229,6 +236,20 @@ export interface SheetMetadata {
 	/** The style of the sheet. */
 	style?: string;
 }
+/**
+ * Detailed indentation information for paragraphs and headings.
+ * Values are typically in twentieths of a point (twips) in OOXML.
+ */
+export interface IndentationMetadata {
+	/** Left indentation. */
+	left?: number;
+	/** Right indentation. */
+	right?: number;
+	/** First line indentation. */
+	firstLine?: number;
+	/** Hanging indentation. */
+	hanging?: number;
+}
 /**
  * Metadata for a heading.
  */
@@ -239,6 +260,8 @@ export interface HeadingMetadata {
 	alignment?: "left" | "center" | "right" | "justify";
 	/** The style of the heading. */
 	style?: string;
+	/** Detailed indentation information. */
+	paragraphIndentation?: IndentationMetadata;
 }
 /**
  * Metadata for a paragraph.
@@ -248,6 +271,8 @@ export interface ParagraphMetadata {
 	alignment?: "left" | "center" | "right" | "justify";
 	/** The style of the paragraph. */
 	style?: string;
+	/** Detailed indentation information. */
+	paragraphIndentation?: IndentationMetadata;
 }
 /**
  * Metadata for a list item.
@@ -263,6 +288,8 @@ export interface ListMetadata {
 	 * @example 0 for top-level items, 1 for first nested level
 	 */
 	indentation: number;
+	/** Detailed indentation information. */
+	paragraphIndentation?: IndentationMetadata;
 	/**
 	 * Text alignment of the list item.
 	 * @example 'left', 'center', 'right', 'justify'
@@ -389,10 +416,35 @@ export interface NoteMetadata {
 	 */
 	noteId?: string;
 }
+/**
+ * Metadata for break nodes.
+ * Used in DOCX files to track line and page breaks.
+ */
+export interface BreakMetadata {
+	/**
+	 * Type of break. The break type determines the next location where
+	 * text shall be placed.
+	 * - 'column': The next text will be placed in the next column.
+	 * - 'page': The next text will be placed on the next page.
+	 * - 'lastRenderedPage': The editing application has inserted a soft break on the last save.
+	 * - 'textWrapping' (default, assumed when not specified): The next text will be placed on the next line.
+	 * - 'carriageReturn': An explicit carriage return (w:cr) equivalent to a hard line break.
+	 */
+	breakType: "column" | "page" | "lastRenderedPage" | "textWrapping" | "carriageReturn";
+	/**
+	 * Specifies the location which shall be used as the next available line when breakType
+	 * has a value of 'textWrapping'. Should be ignored for other break types.
+	 * - 'all': text wrapping break shall advance the text to the next line which spans the full width of the line
+	 * - 'left': text wrapping break shall restart in next text region unblocked on the left
+	 * - 'none': text wrapping break shall advance the text to the next line regardless of any floating objects
+	 * - 'right': text wrapping break shall restart in next text region unblocked on the right
+	 */
+	clear?: "all" | "left" | "none" | "right";
+}
 /**
  * Union type for content metadata.
  */
-export type ContentMetadata = SlideMetadata | SheetMetadata | HeadingMetadata | ListMetadata | CellMetadata | ImageMetadata | ChartMetadata | PageMetadata | ParagraphMetadata | TextMetadata | NoteMetadata | undefined;
+export type ContentMetadata = SlideMetadata | SheetMetadata | HeadingMetadata | ListMetadata | CellMetadata | ImageMetadata | ChartMetadata | PageMetadata | ParagraphMetadata | TextMetadata | NoteMetadata | BreakMetadata | undefined;
 /**
  * Represents a node in the document content tree.
  * This is the core building block of the parsed document structure.