mdream 0.2.4 → 0.2.5

package/README.md

@@ -206,7 +206,7 @@ const adBlockPlugin = createPlugin({
 Extract specific elements and their content during HTML processing for data analysis or content discovery:
 
 ```ts
-import type { ExtractedElement } from 'mdream/plugins'
+import type { ExtractedElement, MdreamRuntimeState } from 'mdream/plugins'
 import { extractionPlugin, htmlToMarkdown } from 'mdream'
 
 const html: string = `
@@ -219,12 +219,14 @@ const html: string = `
 
 // Extract elements using CSS selectors
 const plugin = extractionPlugin({
-  'h2': (element: ExtractedElement): void => {
+  'h2': (element: ExtractedElement, state: MdreamRuntimeState): void => {
     console.log('Heading:', element.textContent) // "Getting Started"
+    console.log('Depth:', state.depth) // Current nesting depth
   },
-  'img[alt]': (element: ExtractedElement): void => {
+  'img[alt]': (element: ExtractedElement, state: MdreamRuntimeState): void => {
     console.log('Image:', element.attributes.src, element.attributes.alt)
     // "Image: /hero.jpg Hero image"
+    console.log('Context:', state.options) // Access to conversion options
   }
 })
 

package/dist/plugins.d.mts

@@ -1,4 +1,4 @@
-import { P as Plugin, b as ElementNode } from './shared/mdream.-SGj02be.mjs';
+import { P as Plugin, b as ElementNode, d as MdreamRuntimeState } from './shared/mdream.-SGj02be.mjs';
 
 /**
  * Create a plugin that implements the Plugin interface with improved type inference
@@ -10,7 +10,7 @@ declare function createPlugin<T extends Partial<Plugin>>(plugin: T): Plugin;
 interface ExtractedElement extends ElementNode {
     textContent: string;
 }
-declare function extractionPlugin(selectors: Record<string, (element: ExtractedElement) => void>): Plugin;
+declare function extractionPlugin(selectors: Record<string, (element: ExtractedElement, state: MdreamRuntimeState) => void>): Plugin;
 
 /**
  * Plugin that filters nodes based on CSS selectors.

package/dist/plugins.d.ts

@@ -1,4 +1,4 @@
-import { P as Plugin, b as ElementNode } from './shared/mdream.-SGj02be.js';
+import { P as Plugin, b as ElementNode, d as MdreamRuntimeState } from './shared/mdream.-SGj02be.js';
 
 /**
  * Create a plugin that implements the Plugin interface with improved type inference
@@ -10,7 +10,7 @@ declare function createPlugin<T extends Partial<Plugin>>(plugin: T): Plugin;
 interface ExtractedElement extends ElementNode {
     textContent: string;
 }
-declare function extractionPlugin(selectors: Record<string, (element: ExtractedElement) => void>): Plugin;
+declare function extractionPlugin(selectors: Record<string, (element: ExtractedElement, state: MdreamRuntimeState) => void>): Plugin;
 
 /**
  * Plugin that filters nodes based on CSS selectors.

package/dist/plugins.mjs

@@ -29,14 +29,14 @@ function extractionPlugin(selectors) {
         currentParent = currentParent.parent;
       }
     },
-    onNodeExit(element) {
+    onNodeExit(element, state) {
       const tracked = trackedElements.get(element);
       if (tracked) {
         const extractedElement = {
           ...element,
           textContent: tracked.textContent.trim()
         };
-        tracked.callback(extractedElement);
+        tracked.callback(extractedElement, state);
         trackedElements.delete(element);
       }
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mdream",
   "type": "module",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Ultra-performant JavaScript HTML to Markdown converter optimized for LLMs.",
   "author": {
     "name": "Harlan Wilton",