marp-dev-preview 0.1.5 → 0.1.6

package/README.md

@@ -84,35 +84,63 @@ In addition to normal browser navigation keys (`Page Up`, `Page Down`, `Home`, `
 
 ---
 
-## 🔗 Integration with Other Tools
-
-The preview server exposes a simple **HTTP API** for controlling slides.  
-
-- Reload the document (the server will parse the received markdown content and incrementally update the presentation). 
-
-    ```bash
-    curl -X POST \
-         -H "Content-Type: text/markdown" \
-         -d "$(cat file-with-updated-content.md)" \ 
-         http://localhost:8080/api/reload
-    ```
-
-- Go to the first slide containing `"my awesome text"`:  
-    ```bash
-    curl -X POST \
-        -H "Content-Type: application/json" \
-        -d '{"command": "find", "string": "my awesome text"}' \
-        http://localhost:8080/api/command
-    ```
-
-- Jump directly to slide 3:  
-
-    ```bash
-    curl -X POST
-        -H "Content-Type: application/json" \
-        -d '{"command": "goto", "slide": 3}' \     
-        http://localhost:8080/api/command
-    ```
+## 🔗 API Endpoints
+
+The preview server exposes a simple **HTTP API** for controlling slides and content.
+
+### `POST /api/reload`
+
+Reloads the presentation with new markdown content. The server parses the received markdown, renders it into HTML, and broadcasts the changes to all connected clients. This is ideal for tools that need to push updates without requiring a full page refresh.
+
+- **Request**:
+  - **Headers**: `Content-Type: text/markdown`
+  - **Body**: Raw markdown content.
+
+- **Response**:
+  - `200 OK`: `{ "status": "ok" }` on success.
+  - `500 Internal Server Error`: `{ "status": "error", "message": "..." }` on failure.
+
+- **Example**:
+  ```bash
+  curl -X POST \
+       -H "Content-Type: text/markdown" \
+       -d "$(cat path/to/your/slides.md)" \
+       http://localhost:8080/api/reload
+  ```
+
+### `POST /api/command`
+
+Sends a command to the browser to control the presentation's navigation. This allows external tools to programmatically change the visible slide.
+
+- **Request**:
+  - **Headers**: `Content-Type: application/json`
+  - **Body**: A JSON object describing the command.
+
+- **Response**:
+  - `200 OK`: `{ "status": "ok", "command": { ... } }` on success.
+  - `400 Bad Request`: `{ "status": "error", "message": "Invalid JSON" }` if the body is malformed.
+
+#### Supported Commands
+
+1.  **`goto`**: Jumps to a specific slide number.
+    - **Payload**: `{ "command": "goto", "slide": <number> }`
+    - **Example**:
+      ```bash
+      curl -X POST \
+           -H "Content-Type: application/json" \
+           -d '{"command": "goto", "slide": 5}' \
+           http://localhost:8080/api/command
+      ```
+
+2.  **`find`**: Searches for a string and jumps to the first slide containing it. The search is case-insensitive.
+    - **Payload**: `{ "command": "find", "string": "<search-term>" }`
+    - **Example**:
+      ```bash
+      curl -X POST \
+           -H "Content-Type: application/json" \
+           -d '{"command": "find", "string": "My Awesome Slide"}' \
+           http://localhost:8080/api/command
+      ```
 
 
 ---

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "marp-dev-preview",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "A CLI tool to preview Marp markdown files.",
-  "main": "marp-dev-preview.mjs",
+  "main": "src/marp-dev-preview.mjs",
   "type": "module",
   "bin": {
-    "mdp": "marp-dev-preview.mjs"
+    "mdp": "src/marp-dev-preview.mjs"
   },
   "scripts": {
-    "start": "node marp-dev-preview.mjs",
+    "start": "node src/marp-dev-preview.mjs",
     "test": "jest"
   },
   "keywords": [

package/{marp-dev-preview.mjs → src/marp-dev-preview.mjs}

@@ -21,7 +21,7 @@ const port = argv.port;
 const verbose = argv.verbose;
 
 if (argv.version) {
-  const pkg = JSON.parse(await fs.readFile(path.join(__dirname, 'package.json'), 'utf8'));
+  const pkg = JSON.parse(await fs.readFile(path.join(__dirname, '..', 'package.json'), 'utf8'));
   console.log(`marp-dev-preview version ${pkg.version}`);
   process.exit(0);
 }

package/{args.test.mjs → test/args.test.mjs}

@@ -1,4 +1,4 @@
-import { parseArgs } from './args.mjs';
+import { parseArgs } from '../src/args.mjs';
 
 const mockArgv = {};
 const defaultValues = {};

package/{marp-dev-preview.test.mjs → test/marp-dev-preview.test.mjs}

@@ -1,4 +1,4 @@
-import { createServer } from './server.mjs';
+import { createServer } from '../src/server.mjs';
 import http from 'http';
 
 jest.mock('http', () => ({

package/{marp-utils.test.mjs → test/marp-utils.test.mjs}

@@ -1,4 +1,4 @@
-import { initializeMarp, renderMarp } from './marp-utils.mjs';
+import { initializeMarp, renderMarp } from '../src/marp-utils.mjs';
 import { Marp } from '@marp-team/marp-core';
 
 jest.mock('@marp-team/marp-core', () => ({