mineru-open-sdk 0.1.1

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,297 @@
+# MinerU Open API SDK (JS/TS)
+
+[![npm version](https://badge.fury.io/js/mineru-open-sdk.svg)](https://badge.fury.io/js/mineru-open-sdk)
+[![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://github.com/opendatalab/MinerU-Ecosystem/blob/main/LICENSE)
+
+[中文文档](./README.zh-CN.md)
+
+**MinerU Open API SDK** is a completely free TypeScript/JavaScript library for the [MinerU](https://mineru.net) document extraction service. Turn any document (PDF, Images, Word, PPT, Excel) or Web Page into high-quality Markdown with just one line of code.
+
+The published package targets Node.js 18+. Bun and Deno can also work when Node-compatible APIs are available. Browser use is not a first-class target today; see [Environment Limits](#-environment-limits).
+
+---
+
+## 🚀 Key Features
+
+- **Completely Free**: No hidden costs for document extraction.
+- **Flash Mode (No Auth)**: Extract text instantly without an API token.
+- **Full Feature Mode**: Comprehensive extraction with layout preservation, images, and formula support.
+- **Blocking And Async Primitives**: Use `extract()` for simple flows, or `submit()` / `getTask()` / `getBatch()` for your own polling logic.
+- **Built-in Save Helpers**: Save Markdown, HTML, LaTeX, DOCX, or the full extracted zip with exported helpers.
+
+---
+
+## 📦 Install
+
+```bash
+npm install mineru-open-sdk
+```
+
+---
+
+## 🛠️ Quick Start
+
+### 1. Flash Extract (Fast, No Auth, Markdown-only)
+Ideal for quick previews. No token required.
+
+```typescript
+import { MinerU } from "mineru-open-sdk";
+
+const client = new MinerU();
+const result = await client.flashExtract(
+  "https://cdn-mineru.openxlab.org.cn/demo/example.pdf",
+);
+
+console.log(result.markdown);
+```
+
+### 2. Full Feature Extract (Auth Required)
+Supports large files, rich assets (images/tables), and multiple formats.
+
+```typescript
+import { MinerU } from "mineru-open-sdk";
+
+const client = new MinerU("your-api-token");
+const result = await client.extract(
+  "https://cdn-mineru.openxlab.org.cn/demo/example.pdf",
+);
+
+console.log(result.markdown);
+console.log(result.images);
+```
+
+---
+
+## 🧩 Supported Public API
+
+### Client lifecycle
+
+- `new MinerU(token?: string, baseUrl = "https://mineru.net/api/v4", flashBaseUrl?: string)`
+- `client.setSource("your-app")`
+
+### Blocking extraction methods
+
+- `client.extract(source, options?) -> Promise<ExtractResult>`
+- `client.extractBatch(sources, options?) -> AsyncGenerator<ExtractResult>`
+- `client.crawl(url, options?) -> Promise<ExtractResult>`
+- `client.crawlBatch(urls, options?) -> AsyncGenerator<ExtractResult>`
+- `client.flashExtract(source, options?) -> Promise<ExtractResult>`
+
+### Submit/query methods
+
+- `client.submit(source, options?) -> Promise<string>`
+- `client.submitBatch(sources, options?) -> Promise<string>`
+- `client.getTask(taskId) -> Promise<ExtractResult>`
+- `client.getBatch(batchId) -> Promise<ExtractResult[]>`
+
+### Result and save helpers
+
+- `saveMarkdown(result, path, withImages = true)`
+- `saveDocx(result, path)`
+- `saveHtml(result, path)`
+- `saveLatex(result, path)`
+- `saveAll(result, dir)`
+- `progressPercent(progress)`
+- `progressToString(progress)`
+
+### Result fields you will usually use
+
+- `result.taskId`
+- `result.state`
+- `result.progress`
+- `result.markdown`
+- `result.images`
+- `result.contentList`
+- `result.docx`
+- `result.html`
+- `result.latex`
+- `result.filename`
+- `result.error`
+
+---
+
+## 📊 Mode Comparison
+
+| Feature | Flash Extract | Full Feature Extract |
+| :--- | :--- | :--- |
+| **Auth** | **No Auth Required** | **Auth Required (Token)** |
+| **Speed** | Blazing Fast | Standard |
+| **File Limit** | Max 10 MB | Max 200 MB |
+| **Page Limit** | Max 20 Pages | Max 600 Pages |
+| **Formats** | PDF, Images, Docx, PPTx, Excel | PDF, Images, Doc/x, Ppt/x, Html |
+| **Content** | Markdown only (Placeholders) | Full assets (Images, Tables, Formulas) |
+| **Output** | Markdown | MD, Docx, LaTeX, HTML, JSON |
+
+---
+
+## ⚙️ Defaults And Option Behavior
+
+### `new MinerU(...)`
+
+| Argument | Default | Behavior when omitted |
+| :--- | :--- | :--- |
+| `token` | `undefined` | Reads `process.env.MINERU_TOKEN` when available |
+| `baseUrl` | `https://mineru.net/api/v4` | Standard API base URL |
+| `flashBaseUrl` | SDK internal flash URL | Override flash API endpoint for testing/private deployments |
+
+If neither `token` nor `process.env.MINERU_TOKEN` is available, the client works in **flash-only mode**: `flashExtract()` works, while auth-required methods throw `NoAuthClientError`.
+
+### Full-feature methods
+
+These defaults apply to `extract()`, `submit()`, `extractBatch()`, and `submitBatch()` unless noted otherwise.
+
+| Option | Default | Behavior when omitted |
+| :--- | :--- | :--- |
+| `model` | `undefined` | Auto-infers model from the source: `.html` / `.htm` becomes `"html"` (`"MinerU-HTML"` at the API layer), everything else uses `"vlm"` |
+| `ocr` | `undefined` | OCR is disabled (API default) |
+| `formula` | `undefined` | Formula recognition is enabled (API default) |
+| `table` | `undefined` | Table recognition is enabled (API default) |
+| `language` | `undefined` | Chinese `"ch"` (API default) |
+| `pages` | `undefined` | Full document is processed. Only available on single-source `extract()` / `submit()` |
+| `extraFormats` | `undefined` | Only the default Markdown/JSON payload is returned |
+| `fileParams` | `undefined` | Per-file overrides for batch methods. Keys are paths/URLs, values are `{ pages?, ocr?, dataId? }` |
+| `timeout` | `300` seconds | Max total polling time for `extract()` / `crawl()` |
+| `timeout` | `1800` seconds | Max total polling time for `extractBatch()` / `crawlBatch()` |
+
+### `crawl()` / `crawlBatch()`
+
+- `crawl()` is shorthand for `extract(url, { model: "html", ... })`
+- `crawlBatch()` is shorthand for `extractBatch(urls, { model: "html", ... })`
+- `crawl()` / `crawlBatch()` only expose `extraFormats` and `timeout`, not OCR/table/formula switches
+
+### Flash mode
+
+| Option | Default | Behavior when omitted |
+| :--- | :--- | :--- |
+| `language` | `"ch"` | Chinese is the default |
+| `pageRange` | `undefined` | Full page range allowed by the flash API |
+| `timeout` | `300` seconds | Max total polling time |
+
+---
+
+## 🌍 Environment Limits
+
+- `extract("./file.pdf")`, `submit("./file.pdf")`, `flashExtract("./file.pdf")`, and all save helpers rely on `node:fs/promises` and `node:path`. Use them in Node.js, Bun, or Deno with Node compatibility.
+- Standard browser runtimes are not a first-class target today because the SDK imports Node modules for local-file and save helpers. If your toolchain can bundle it anyway, stick to URL-based inputs and in-memory results.
+- The `MINERU_TOKEN` fallback is Node-style. In browsers, pass the token explicitly: `new MinerU("your-api-token")`.
+- Flash results only contain Markdown. `saveDocx()`, `saveHtml()`, `saveLatex()`, and `saveAll()` require a full-feature result that has already reached `state === "done"`.
+
+---
+
+## 📖 Detailed Usage
+
+### Full Feature Extraction Options
+
+```typescript
+import { MinerU, saveAll } from "mineru-open-sdk";
+
+const client = new MinerU("your-api-token");
+
+const result = await client.extract("./paper.pdf", {
+  model: "vlm",              // "vlm" | "pipeline" | "html"
+  ocr: true,
+  formula: true,
+  table: true,
+  language: "en",
+  pages: "1-20",
+  extraFormats: ["docx"],
+  timeout: 600,
+});
+
+await saveAll(result, "./output");
+```
+
+### Batch Processing
+
+```typescript
+for await (const result of client.extractBatch(["a.pdf", "b.pdf"])) {
+  console.log(`${result.filename}: ${result.state}`);
+}
+```
+
+### Batch With Per-File Pages
+
+```typescript
+const batchId = await client.submitBatch(["a.pdf", "b.pdf"], {
+  fileParams: {
+    "a.pdf": { pages: "1-5" },
+    "b.pdf": { pages: "10-20" },
+  },
+});
+```
+
+### Web Crawling
+
+```typescript
+const result = await client.crawl("https://www.baidu.com");
+console.log(result.markdown);
+```
+
+---
+
+## 🔄 `submit()` / `getBatch()` Semantics
+
+The important rule is simple:
+
+- `submit()` returns a **batch ID**
+- `submitBatch()` also returns a **batch ID**
+- the normal async flow is therefore `submit(...) -> getBatch(batchId)`
+- `getTask(taskId)` is only useful when you obtained a real task ID from somewhere else, not from `submit()`
+
+### Why `submit()` returns a batch ID
+
+The SDK deliberately normalizes both single-URL and local-file submissions onto batch semantics:
+
+- a single URL is submitted through the batch endpoint internally
+- a single local file is uploaded through the batch upload flow internally
+- that means `submit()` always gives you a batch-oriented handle
+
+### `submitBatch()` returns what
+
+- `submitBatch([...])` always returns a **batch ID**
+- `submitBatch()` does **not** allow mixing URLs and local files in one call
+- `extractBatch()` does allow mixed sources because it internally creates separate batches and merges the completed results for you
+
+### Recommended polling pattern
+
+```typescript
+const batchId = await client.submit("https://example.com/report.pdf");
+
+while (true) {
+  const [result] = await client.getBatch(batchId);
+  if (result && (result.state === "done" || result.state === "failed")) {
+    break;
+  }
+}
+```
+
+### What the query methods populate
+
+- If a queried result is still pending/running, you only get metadata such as `state`, `progress`, `taskId`, and possible error fields
+- Once a result reaches `state === "done"` and includes a zip URL, `getBatch()` automatically downloads and parses the zip so `markdown`, `images`, `contentList`, `docx`, `html`, and `latex` become available
+
+---
+
+## 🤖 Integration for AI Agents
+
+The SDK exposes enough state for agent loops via `result.state` and `result.progress`.
+
+```typescript
+const batchId = await client.submit("https://example.com/large-report.pdf");
+
+const [result] = await client.getBatch(batchId);
+if (result?.state === "done") {
+  processMarkdown(result.markdown);
+}
+```
+
+---
+
+## 📄 License
+
+This project is licensed under the Apache-2.0 License.
+
+## 🔗 Links
+
+- [Official Website](https://mineru.net)
+- [API Documentation](https://mineru.net/docs)