@markitdownjs/xlsx 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MarkItDownJS Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,60 @@
+# @markitdownjs/xlsx
+
+[![npm](https://img.shields.io/npm/v/@markitdownjs/xlsx)](https://www.npmjs.com/package/@markitdownjs/xlsx)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Excel (XLSX) to AST converter for MarkItDownJS. Converts spreadsheet sheets into structured `TableNode` AST nodes with headers and rows.
+
+## Install
+
+```bash
+npm install @markitdownjs/xlsx
+```
+
+## Usage
+
+```ts
+import { MarkItDown } from "@markitdownjs/core";
+import { XlsxConverter } from "@markitdownjs/xlsx";
+
+const parser = new MarkItDown();
+parser.registerConverter(new XlsxConverter());
+
+const result = await parser.convert({
+  source: xlsxBuffer,
+  mimeType: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+});
+console.log(result.markdown);
+```
+
+## Key Exports
+
+| Export | Description |
+|---|---|
+| `XlsxConverter` | Converter plugin — register with `MarkItDown` |
+
+## What Gets Extracted
+
+- Each sheet becomes a separate `TableNode` with the sheet name as a heading
+- First row treated as the header row (configurable)
+- Cell values normalized to strings; numbers and dates are formatted
+- Empty rows and columns are skipped by default
+
+## Options
+
+```ts
+parser.registerConverter(new XlsxConverter({
+  firstRowAsHeader: true,
+  skipEmptyRows: true,
+  sheets: ["Sheet1", "Summary"], // process only specific sheets
+}));
+```
+
+## Accepted MIME Types
+
+- `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
+- `application/vnd.ms-excel`
+
+---
+
+Part of the [MarkItDownJS](https://github.com/markitdownjs/markitdownjs) monorepo.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markitdownjs/xlsx",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Excel (XLSX) converter for MarkItDownJS",
   "license": "MIT",
   "type": "module",
@@ -18,8 +18,8 @@
   ],
   "dependencies": {
     "jszip": "^3.10.0",
-    "@markitdownjs/ast": "0.1.0",
-    "@markitdownjs/shared": "0.1.0"
+    "@markitdownjs/ast": "0.1.1",
+    "@markitdownjs/shared": "0.1.1"
   },
   "devDependencies": {
     "typescript": "^5.5.0"