@markitdownjs/api 0.1.0 → 0.1.2

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/api
+
+[![npm](https://img.shields.io/npm/v/@markitdownjs/api)](https://www.npmjs.com/package/@markitdownjs/api)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Hono-based HTTP API server for document conversion. Part of [MarkItDownJS](https://github.com/markitdownjs/markitdownjs). Deploy as a standalone microservice or embed in any Node.js app.
+
+## Install
+
+```bash
+npm install @markitdownjs/api @markitdownjs/core
+```
+
+## Usage
+
+```ts
+import { startServer } from "@markitdownjs/api";
+
+startServer({ port: 3000 });
+```
+
+### Embed in an existing Hono or Node app
+
+```ts
+import { createApp } from "@markitdownjs/api";
+import { MarkItDown } from "@markitdownjs/core";
+import { PdfConverter } from "@markitdownjs/pdf";
+
+const parser = new MarkItDown();
+parser.registerConverter(new PdfConverter());
+
+const app = createApp({ parser });
+// Mount `app` into your existing Hono/Express instance
+```
+
+## Endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `POST` | `/convert` | Convert a single file (`multipart/form-data`, field: `file`) |
+| `POST` | `/batch` | Convert multiple files in one request |
+| `GET` | `/health` | Health check — returns `{ status: "ok" }` |
+| `GET` | `/formats` | List registered converter MIME types |
+
+## Docker
+
+```bash
+npx @markitdownjs/cli serve --port 3000
+```
+
+## API
+
+| Export | Description |
+|--------|-------------|
+| `createApp(opts)` | Returns a configured Hono app instance |
+| `startServer(opts)` | Creates the app and starts a Node.js HTTP listener |
+
+## Part of the MarkItDownJS Monorepo
+
+[https://github.com/markitdownjs/markitdownjs](https://github.com/markitdownjs/markitdownjs)

package/dist/app.d.ts

@@ -1,4 +1,4 @@
-import { Hono } from 'hono';
+import { Hono } from "hono";
 declare const app: Hono<import("hono/types").BlankEnv, import("hono/types").BlankSchema, "/">;
 export default app;
 //# sourceMappingURL=app.d.ts.map

package/dist/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAI5B,QAAA,MAAM,GAAG,4EAAa,CAAC;AAyCvB,eAAe,GAAG,CAAC"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAI5B,QAAA,MAAM,GAAG,4EAAa,CAAC;AAsCvB,eAAe,GAAG,CAAC"}

package/dist/app.js

@@ -1,23 +1,23 @@
-import { Hono } from 'hono';
-import { cors } from 'hono/cors';
-import { getSupportedExtensions, getSupportedMimeTypes } from '@markitdownjs/shared';
+import { Hono } from "hono";
+import { cors } from "hono/cors";
+import { getSupportedExtensions, getSupportedMimeTypes } from "@markitdownjs/shared";
 const app = new Hono();
-app.use('/*', cors());
-app.get('/health', (c) => c.json({ status: 'ok', timestamp: new Date().toISOString() }));
-app.get('/formats', async (c) => {
+app.use("/*", cors());
+app.get("/health", (c) => c.json({ status: "ok", timestamp: new Date().toISOString() }));
+app.get("/formats", async (c) => {
     return c.json({
         extensions: getSupportedExtensions(),
         mimeTypes: getSupportedMimeTypes(),
     });
 });
-app.post('/convert', async (c) => {
+app.post("/convert", async (c) => {
     try {
         const body = await c.req.parseBody();
-        const file = body['file'];
+        const file = body["file"];
         if (!file || !(file instanceof File)) {
-            return c.json({ error: 'No file provided' }, 400);
+            return c.json({ error: "No file provided" }, 400);
         }
-        const { MarkItDown } = await import('@markitdownjs/core');
+        const { MarkItDown } = await import("@markitdownjs/core");
         const parser = new MarkItDown();
         const arrayBuffer = await file.arrayBuffer();
         const result = await parser.convert({
@@ -28,7 +28,7 @@ app.post('/convert', async (c) => {
         return c.json(result);
     }
     catch (error) {
-        return c.json({ error: error instanceof Error ? error.message : 'Conversion failed' }, 500);
+        return c.json({ error: error instanceof Error ? error.message : "Conversion failed" }, 500);
     }
 });
 export default app;

package/dist/app.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAErF,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;AAEvB,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;AAEtB,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;AAEzF,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAC9B,OAAO,CAAC,CAAC,IAAI,CAAC;QACZ,UAAU,EAAE,sBAAsB,EAAE;QACpC,SAAS,EAAE,qBAAqB,EAAE;KACnC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAC/B,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAE1B,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;YACrC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAEhC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAClC,IAAI,EAAE,IAAI,UAAU,CAAC,WAAW,CAAC;YACjC,QAAQ,EAAE,IAAI,CAAC,IAAI;YACnB,QAAQ,EAAE,IAAI,CAAC,IAAI,IAAI,SAAS;SACjC,CAAC,CAAC;QAEH,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,CAAC,IAAI,CACX,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,EAAE,EACvE,GAAG,CACJ,CAAC;IACJ,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,eAAe,GAAG,CAAC"}
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAErF,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;AAEvB,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;AAEtB,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;AAEzF,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAC9B,OAAO,CAAC,CAAC,IAAI,CAAC;QACZ,UAAU,EAAE,sBAAsB,EAAE;QACpC,SAAS,EAAE,qBAAqB,EAAE;KACnC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAC/B,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAE1B,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;YACrC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,EAAE,GAAG,CAAC,CAAC;QACpD,CAAC;QAED,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAEhC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAClC,IAAI,EAAE,IAAI,UAAU,CAAC,WAAW,CAAC;YACjC,QAAQ,EAAE,IAAI,CAAC,IAAI;YACnB,QAAQ,EAAE,IAAI,CAAC,IAAI,IAAI,SAAS;SACjC,CAAC,CAAC;QAEH,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,EAAE,EAAE,GAAG,CAAC,CAAC;IAC9F,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,eAAe,GAAG,CAAC"}

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { default as app } from './app.js';
-export { rateLimit, validateFileSize } from './middleware.js';
+export { default as app } from "./app.js";
+export { rateLimit, validateFileSize } from "./middleware.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,3 +1,3 @@
-export { default as app } from './app.js';
-export { rateLimit, validateFileSize } from './middleware.js';
+export { default as app } from "./app.js";
+export { rateLimit, validateFileSize } from "./middleware.js";
 //# sourceMappingURL=index.js.map

package/dist/middleware.d.ts

@@ -1,4 +1,4 @@
-import type { Context, Next } from 'hono';
+import type { Context, Next } from "hono";
 export declare function rateLimit(options?: {
     windowMs?: number;
     max?: number;

package/dist/middleware.js

@@ -3,7 +3,7 @@ export function rateLimit(options = {}) {
     const windowMs = options.windowMs ?? 60_000;
     const max = options.max ?? 100;
     return async (c, next) => {
-        const ip = c.req.header('x-forwarded-for') ?? c.req.header('x-real-ip') ?? 'unknown';
+        const ip = c.req.header("x-forwarded-for") ?? c.req.header("x-real-ip") ?? "unknown";
         const now = Date.now();
         const record = requestCounts.get(ip);
         if (!record || now > record.resetTime) {
@@ -12,16 +12,16 @@ export function rateLimit(options = {}) {
         }
         record.count++;
         if (record.count > max) {
-            return c.json({ error: 'Too many requests' }, 429);
+            return c.json({ error: "Too many requests" }, 429);
         }
         return next();
     };
 }
 const MAX_FILE_SIZE = 50 * 1024 * 1024;
 export async function validateFileSize(c, next) {
-    const contentLength = c.req.header('content-length');
+    const contentLength = c.req.header("content-length");
     if (contentLength && parseInt(contentLength, 10) > MAX_FILE_SIZE) {
-        return c.json({ error: 'File too large. Maximum size is 50MB' }, 413);
+        return c.json({ error: "File too large. Maximum size is 50MB" }, 413);
     }
     return next();
 }

package/dist/server.js

@@ -1,6 +1,6 @@
-import { serve } from '@hono/node-server';
-import app from './app.js';
-const port = parseInt(process.env.PORT ?? '3000', 10);
+import { serve } from "@hono/node-server";
+import app from "./app.js";
+const port = parseInt(process.env.PORT ?? "3000", 10);
 serve({ fetch: app.fetch, port }, (info) => {
     console.log(`MarkItDownJS API server running on http://localhost:${info.port}`);
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markitdownjs/api",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "HTTP API server for MarkItDownJS document conversion",
   "license": "MIT",
   "type": "module",
@@ -18,8 +18,8 @@
   ],
   "dependencies": {
     "hono": "^4.0.0",
-    "@markitdownjs/core": "0.1.0",
-    "@markitdownjs/shared": "0.1.0"
+    "@markitdownjs/core": "0.2.0",
+    "@markitdownjs/shared": "0.2.0"
   },
   "devDependencies": {
     "typescript": "^5.5.0",