@markitdownjs/react 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,63 @@
+# @markitdownjs/react
+
+[![npm](https://img.shields.io/npm/v/@markitdownjs/react)](https://www.npmjs.com/package/@markitdownjs/react)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+React hooks and components for document conversion in browser and React apps. Part of [MarkItDownJS](https://github.com/markitdownjs/markitdownjs).
+
+**Peer dependency:** `react >= 18.0.0`
+
+## Install
+
+```bash
+npm install @markitdownjs/react @markitdownjs/core
+npm install react react-dom  # peer dependencies
+```
+
+## Usage
+
+```tsx
+import { useDocumentParser } from "@markitdownjs/react";
+
+function UploadPage() {
+  const { convert, result, loading, error } = useDocumentParser();
+
+  return (
+    <input
+      type="file"
+      onChange={(e) => convert(e.target.files![0])}
+    />
+  );
+}
+```
+
+## API
+
+### `useDocumentParser(options?)`
+
+Returns `{ convert, result, loading, error, reset }`.
+
+### `useMarkdownConversion(source, mimeType)`
+
+Returns `{ markdown, loading, error }` — converts a source directly to a Markdown string.
+
+### `useDocumentChunks(source, mimeType, options?)`
+
+Returns `{ chunks, loading, error }` — splits the converted document into chunked nodes, useful for RAG pipelines.
+
+### `DocumentProvider`
+
+Context provider. Wrap your app to share a single `MarkItDown` instance and registered converters across all hooks.
+
+```tsx
+import { DocumentProvider } from "@markitdownjs/react";
+import { JsonConverter } from "@markitdownjs/json";
+
+<DocumentProvider converters={[new JsonConverter()]}>
+  <App />
+</DocumentProvider>
+```
+
+## Part of the MarkItDownJS Monorepo
+
+[https://github.com/markitdownjs/markitdownjs](https://github.com/markitdownjs/markitdownjs)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markitdownjs/react",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "React hooks and components for MarkItDownJS document conversion",
   "license": "MIT",
   "type": "module",
@@ -17,7 +17,7 @@
     "dist"
   ],
   "dependencies": {
-    "@markitdownjs/shared": "0.1.0"
+    "@markitdownjs/shared": "0.1.1"
   },
   "peerDependencies": {
     "react": ">=18.0.0"
@@ -26,7 +26,7 @@
     "typescript": "^5.5.0",
     "react": "^18.2.0",
     "@types/react": "^18.2.0",
-    "@markitdownjs/core": "0.1.0"
+    "@markitdownjs/core": "0.1.1"
   },
   "scripts": {
     "build": "tsc --project tsconfig.json",