@dragon708/docmind-node 1.10.0 → 1.11.0

package/dist/index.d.ts

@@ -6,6 +6,8 @@ import { AnalyzeDocxIncludeFlags, DocxToHtmlOptions, ExtractStructuredDataFromDo
 export { AnalyzeDocxIncludeFlags, DocxEmbeddedImage, DocxEmbeddedImageConversionOptions, DocxEmbeddedImageConversionResult, DocxEmbeddedImageWebSlice, DocxImageExtractionMode, ExtractImagesFromDocxOptions, ExtractImagesFromDocxResult, ExtractStructuredDataFromDocxOptions, convertDocxEmbeddedImageToWeb, convertDocxImagesForWeb, docxImageIsBrowserRenderable, docxImageRequiresConversion, docxImageSuggestedTargetFormat, docxImageToDataUri, extractImagesFromDocx, extractStructuredDataFromDocx, isNodeJsRuntime } from '@dragon708/docmind-docx';
 import { PdfAnalyzeOptions, ExtractStructuredDataFromPdfOptions } from '@dragon708/docmind-pdf';
 export { ExtractStructuredDataFromPdfIncludeFlags, ExtractStructuredDataFromPdfOptions, extractStructuredDataFromPdf } from '@dragon708/docmind-pdf';
+import { RenderLlmTextOptions, RenderMarkdownOptions, RenderMarkdownSectionsOptions, MarkdownSection } from '@dragon708/docmind-markdown';
+export { MarkdownSection } from '@dragon708/docmind-markdown';
 
 /**
  * Options for Node public APIs (`analyzeFile`, intent methods).
@@ -50,6 +52,24 @@ interface NodeExtractStructuredDataOptions extends DocMindAnalyzeOptions {
     readonly ocr?: ExtractStructuredDataFromImageOptions;
     readonly normalize?: NormalizeStructuredOptions;
 }
+/**
+ * {@link extractMarkdown}: inherits {@link NodeExtractStructuredDataOptions}; set `markdown` for `renderMarkdown` knobs (`@dragon708/docmind-markdown`).
+ */
+interface NodeExtractMarkdownOptions extends NodeExtractStructuredDataOptions {
+    readonly markdown?: RenderMarkdownOptions;
+}
+/**
+ * {@link extractLlmContent}: same structured fields; `llm` forwards to `renderLlmText`.
+ */
+interface NodeExtractLlmContentOptions extends NodeExtractStructuredDataOptions {
+    readonly llm?: RenderLlmTextOptions;
+}
+/**
+ * {@link extractStructuredChunks}: `chunks` maps to split/render options (`maxChars`, `preferHeadings`, etc.).
+ */
+interface NodeExtractStructuredChunksOptions extends NodeExtractStructuredDataOptions {
+    readonly chunks?: RenderMarkdownSectionsOptions;
+}
 
 /**
  * Inputs accepted by {@link analyzeFile} in this package.
@@ -104,8 +124,34 @@ declare function runOcr(input: NodeAnalyzeInput, options?: NodeAnalyzeOptions):
  */
 declare function extractStructuredData(input: NodeAnalyzeInput, options?: NodeExtractStructuredDataOptions): Promise<StructuredDocumentResult>;
 
+/**
+ * End-to-end: resolve bytes → {@link extractStructuredData} → `renderMarkdown` (`@dragon708/docmind-markdown`).
+ *
+ * @param input - Path, buffer, or {@link NodeAnalyzeInput} accepted by the Node facade.
+ * @param options - Structured routing (`pdf` / `docx` / `ocr` / `normalize`) plus optional `markdown` render options.
+ */
+declare function extractMarkdown(input: NodeAnalyzeInput, options?: NodeExtractMarkdownOptions): Promise<string>;
+/**
+ * Same routing as {@link extractMarkdown}, then `renderLlmText` for prompts / RAG.
+ *
+ * @param options - Optional `llm` slice forwarded to `@dragon708/docmind-markdown`.
+ */
+declare function extractLlmContent(input: NodeAnalyzeInput, options?: NodeExtractLlmContentOptions): Promise<string>;
+/**
+ * Structured extract → `renderMarkdownSections` (Markdown + optional parallel `text` per slice).
+ *
+ * @param options - Optional `chunks` (e.g. `maxChars`, `preferHeadings`) from `@dragon708/docmind-markdown`.
+ */
+declare function extractStructuredChunks(input: NodeAnalyzeInput, options?: NodeExtractStructuredChunksOptions): Promise<readonly MarkdownSection[]>;
+
 /** High-level features the user can ask DocMind for (per input kind and runtime). */
-type PublicCapabilityId = "text" | "metadata" | "html" | "ocr" | "pages" | "structured-output" | "ocr-multipage" | "image-normalization" | "tiff" | "heic-node-only" | "bmp" | "gif-first-frame";
+type PublicCapabilityId = "text" | "metadata" | "html" | "ocr" | "pages" | "structured-output"
+/** Node: {@link extractMarkdown} after {@link extractStructuredData} via `@dragon708/docmind-markdown`. */
+ | "markdown"
+/** Node: {@link extractLlmContent} (LLM-oriented plain text). */
+ | "llm-text"
+/** Node: {@link extractStructuredChunks} (Markdown sections / chunking). */
+ | "structured-chunks" | "ocr-multipage" | "image-normalization" | "tiff" | "heic-node-only" | "bmp" | "gif-first-frame";
 /**
  * DOCX-only: what the stack can do with OOXML embedded bitmaps/vector payloads under `word/media`.
  * Present on {@link GetCapabilitiesReport} when `kind === "docx"`.
@@ -193,12 +239,17 @@ interface ExplainAnalysisPlanReport {
     readonly warnings?: readonly string[];
 }
 
+/** Node-only intents layered on `@dragon708/docmind-markdown` after structured extraction. */
+type NodeMarkdownFacadeIntent = "extractMarkdown" | "extractLlmContent" | "extractStructuredChunks";
 /** Options for {@link explainAnalysisPlan} including PDF/OCR/DOCX hints for accurate planning. */
-type NodeExplainAnalysisPlanOptions = ExplainAnalysisPlanOptions & Pick<NodeAnalyzeOptions, "pdf" | "ocr" | "docx" | "structuredOutput" | "output">;
+type NodeExplainAnalysisPlanOptions = Omit<ExplainAnalysisPlanOptions, "intent"> & Pick<NodeAnalyzeOptions, "pdf" | "ocr" | "docx" | "structuredOutput" | "output"> & {
+    readonly intent?: DocMindPublicIntent | NodeMarkdownFacadeIntent;
+};
 
 /**
  * Epic 1 — **Capabilities:** after resolving {@link NodeAnalyzeInput}, lists which of
- * `text` | `metadata` | `html` | `ocr` | `pages` | `structured-output` (and image-specific ids such as `ocr-multipage`, `image-normalization`, `tiff`, `heic-node-only`, `bmp`, `gif-first-frame`) apply for that kind in Node (for PDF, `text` / `metadata` /
+ * `text` | `metadata` | `html` | `ocr` | `pages` | `structured-output` | `markdown` | `llm-text` | `structured-chunks`
+ * (and image-specific ids such as `ocr-multipage`, `image-normalization`, `tiff`, `heic-node-only`, `bmp`, `gif-first-frame`) apply for that kind in Node (for PDF, `text` / `metadata` /
  * `pages` / `ocr` describe the v2 pdf-parse + PDF.js + OCR stack; see {@link buildNodeCapabilityReport}).
  * For **DOCX**, `docxEmbeddedImages` and `docxStructure` describe ZIP media and optional OOXML v2 extractors (`options.docx.include`).
  * Does not run Mammoth/Tesseract/PDF bodies beyond path resolution.
@@ -210,4 +261,4 @@ declare function getCapabilities(input: NodeAnalyzeInput, options?: GetCapabilit
  */
 declare function explainAnalysisPlan(input: NodeAnalyzeInput, options?: NodeExplainAnalysisPlanOptions): Promise<ExplainAnalysisPlanReport>;
 
-export { DOCX_EMBEDDED_IMAGE_CAPABILITIES, DOCX_STRUCTURE_CAPABILITIES, type DocxEmbeddedImageCapabilities, type DocxStructuralCapabilities, type ExplainAnalysisPlanReport, type GetCapabilitiesReport, type NativeExtractionPlan, type NodeAnalyzeDocxOptionsSlice, type NodeAnalyzeInput, type NodeAnalyzeOptions, type NodeExplainAnalysisPlanOptions, type NodeExtractStructuredDataOptions, type OcrPlan, type PublicCapabilityId, type PublicCapabilitySupport, analyzeFile, bufferToInput, convertToHtml, docxIncludeRequested, explainAnalysisPlan, extractMetadata, extractStructuredData, extractText, getCapabilities, readFileToInput, resolveNodeAnalyzeInput, runOcr };
+export { DOCX_EMBEDDED_IMAGE_CAPABILITIES, DOCX_STRUCTURE_CAPABILITIES, type DocxEmbeddedImageCapabilities, type DocxStructuralCapabilities, type ExplainAnalysisPlanReport, type GetCapabilitiesReport, type NativeExtractionPlan, type NodeAnalyzeDocxOptionsSlice, type NodeAnalyzeInput, type NodeAnalyzeOptions, type NodeExplainAnalysisPlanOptions, type NodeExtractLlmContentOptions, type NodeExtractMarkdownOptions, type NodeExtractStructuredChunksOptions, type NodeExtractStructuredDataOptions, type NodeMarkdownFacadeIntent, type OcrPlan, type PublicCapabilityId, type PublicCapabilitySupport, analyzeFile, bufferToInput, convertToHtml, docxIncludeRequested, explainAnalysisPlan, extractLlmContent, extractMarkdown, extractMetadata, extractStructuredChunks, extractStructuredData, extractText, getCapabilities, readFileToInput, resolveNodeAnalyzeInput, runOcr };

package/dist/index.js

@@ -9,6 +9,7 @@ export { extractStructuredDataFromPdf } from '@dragon708/docmind-pdf';
 import { readFile } from 'fs/promises';
 import { basename } from 'path';
 import { fileURLToPath } from 'url';
+import { renderMarkdown, renderLlmText, renderMarkdownSections } from '@dragon708/docmind-markdown';
 
 // src/analyze.ts
 
@@ -617,6 +618,24 @@ async function runOcr(input, options) {
       return notImplementedResult(kind, "none", [UNKNOWN_FORMAT_WARNING]);
   }
 }
+async function extractMarkdown(input, options) {
+  throwIfAborted(options?.signal);
+  const { markdown: markdownOpts, ...structuredOpts } = options ?? {};
+  const structured = await extractStructuredData(input, structuredOpts);
+  return renderMarkdown(structured, markdownOpts);
+}
+async function extractLlmContent(input, options) {
+  throwIfAborted(options?.signal);
+  const { llm: llmOpts, ...structuredOpts } = options ?? {};
+  const structured = await extractStructuredData(input, structuredOpts);
+  return renderLlmText(structured, llmOpts);
+}
+async function extractStructuredChunks(input, options) {
+  throwIfAborted(options?.signal);
+  const { chunks: chunkOpts, ...structuredOpts } = options ?? {};
+  const structured = await extractStructuredData(input, structuredOpts);
+  return renderMarkdownSections(structured, chunkOpts);
+}
 
 // src/capabilityReport.ts
 function docxIncludeRequested(flags) {
@@ -679,6 +698,15 @@ function buildNodeCapabilityReport(kind) {
         slot("html", true, ["HTML is a <pre> preview of extracted text, not visual layout."]),
         slot("structured-output", true, [
           "extractStructuredData: analyzePdf + PDF.js per-page text, outline, links, annotations, merged via normalizeToStructuredResult; respects pdf.ocr like analyzeFile."
+        ]),
+        slot("markdown", true, [
+          "extractMarkdown: same structured pipeline, then `@dragon708/docmind-markdown` renderMarkdown (GFM-style)."
+        ]),
+        slot("llm-text", true, [
+          "extractLlmContent: structured \u2192 compact plain text (renderLlmText) for prompts / embeddings."
+        ]),
+        slot("structured-chunks", true, [
+          "extractStructuredChunks: structured \u2192 Markdown sections via split/render (heading-aware chunking)."
         ])
       ];
       break;
@@ -699,6 +727,13 @@ function buildNodeCapabilityReport(kind) {
         ]),
         slot("structured-output", true, [
           "extractStructuredData runs analyzeDocx with merged OOXML includes (blocks, tables, headings, embedded images, etc.) into StructuredDocumentResult."
+        ]),
+        slot("markdown", true, [
+          "extractMarkdown: structured DOCX envelope \u2192 Markdown (`@dragon708/docmind-markdown`)."
+        ]),
+        slot("llm-text", true, ["extractLlmContent: structured \u2192 LLM-oriented plain text."]),
+        slot("structured-chunks", true, [
+          "extractStructuredChunks: structured \u2192 sectioned Markdown chunks."
         ])
       ];
       break;
@@ -733,7 +768,12 @@ function buildNodeCapabilityReport(kind) {
         ]),
         slot("structured-output", true, [
           "extractStructuredData: OCR + layout blocks (ocrImageDetailed / ocrTiff) normalized to StructuredDocumentResult."
-        ])
+        ]),
+        slot("markdown", true, [
+          "extractMarkdown: OCR structured layout \u2192 Markdown (tables/lists as GFM where blocks exist)."
+        ]),
+        slot("llm-text", true, ["extractLlmContent: OCR structured \u2192 LLM plain text."]),
+        slot("structured-chunks", true, ["extractStructuredChunks: OCR structured \u2192 Markdown sections."])
       ];
       break;
     case "text":
@@ -745,6 +785,13 @@ function buildNodeCapabilityReport(kind) {
         slot("pages", false),
         slot("structured-output", true, [
           "extractStructuredData wraps UTF-8 decode in normalizeToStructuredResult (rollup text only unless you add blocks upstream)."
+        ]),
+        slot("markdown", true, [
+          "extractMarkdown: rollup/decoded text \u2192 Markdown (mostly paragraphs; no layout without upstream blocks)."
+        ]),
+        slot("llm-text", true, ["extractLlmContent: rollup \u2192 LLM plain text via the same envelope."]),
+        slot("structured-chunks", true, [
+          "extractStructuredChunks: single-chunk Markdown is typical when only rollup text exists."
         ])
       ];
       break;
@@ -756,7 +803,10 @@ function buildNodeCapabilityReport(kind) {
         slot("html", false),
         slot("ocr", false),
         slot("pages", false),
-        slot("structured-output", false)
+        slot("structured-output", false),
+        slot("markdown", false),
+        slot("llm-text", false),
+        slot("structured-chunks", false)
       ];
   }
   return {
@@ -967,10 +1017,13 @@ function buildNodeExplainReport(kind, intent, pdfOcr, plan, docxInclude, ocrSlic
       }
       break;
     case "extractStructuredData":
+    case "extractMarkdown":
+    case "extractLlmContent":
+    case "extractStructuredChunks":
       if (kind === "pdf") {
         nativeExtraction = {
           willAttempt: true,
-          description: "extractStructuredData: analyzePdf plus PDF.js page rows, outline, links, and annotations, normalized to StructuredDocumentResult."
+          description: intent === "extractStructuredData" ? "extractStructuredData: analyzePdf plus PDF.js page rows, outline, links, and annotations, normalized to StructuredDocumentResult." : `${intent}: same structured PDF pipeline as extractStructuredData, then \`@dragon708/docmind-markdown\`.`
         };
         ocr = {
           mayUse: pdfOcr !== "off",
@@ -979,7 +1032,7 @@ function buildNodeExplainReport(kind, intent, pdfOcr, plan, docxInclude, ocrSlic
       } else if (kind === "docx") {
         nativeExtraction = {
           willAttempt: true,
-          description: "extractStructuredData: Mammoth plus merged OOXML extractors (structure, headings, tables, blocks, pagesApprox, embeddedImages) in one envelope."
+          description: intent === "extractStructuredData" ? "extractStructuredData: Mammoth plus merged OOXML extractors (structure, headings, tables, blocks, pagesApprox, embeddedImages) in one envelope." : `${intent}: same structured DOCX pipeline as extractStructuredData, then \`@dragon708/docmind-markdown\`.`
         };
         ocr = { mayUse: false, description: "DOCX does not use OCR." };
       } else if (kind === "image") {
@@ -994,11 +1047,29 @@ function buildNodeExplainReport(kind, intent, pdfOcr, plan, docxInclude, ocrSlic
       } else {
         nativeExtraction = {
           willAttempt: true,
-          description: "UTF-8 decode with BOM handling; normalizeToStructuredResult produces the structured envelope."
+          description: intent === "extractStructuredData" ? "UTF-8 decode with BOM handling; normalizeToStructuredResult produces the structured envelope." : `${intent}: UTF-8 structured envelope, then \`@dragon708/docmind-markdown\` export.`
         };
         ocr = { mayUse: false, description: "OCR does not apply to text files." };
         limitations = lim("Plain text has no native layout blocks; `text` carries the decoded content.");
       }
+      if (intent === "extractMarkdown") {
+        limitations = [
+          ...limitations,
+          ...lim("Output: Markdown string via renderMarkdown (tables, headings, lists).")
+        ];
+      } else if (intent === "extractLlmContent") {
+        limitations = [
+          ...limitations,
+          ...lim("Output: compact plain text via renderLlmText (prompt / embedding friendly).")
+        ];
+      } else if (intent === "extractStructuredChunks") {
+        limitations = [
+          ...limitations,
+          ...lim(
+            "Output: MarkdownSection[] via renderMarkdownSections (splitStructuredIntoChunks under the hood)."
+          )
+        ];
+      }
       break;
     default:
       nativeExtraction = { willAttempt: false, description: "Generic intent; see plan." };
@@ -1266,6 +1337,23 @@ function planForIntent(intentOpt, kind, pdfOcrForAnalyze, docxInclude, ocr, anal
         };
     }
   }
+  if (intent === "extractMarkdown" || intent === "extractLlmContent" || intent === "extractStructuredChunks") {
+    const sub = planForIntent(
+      "extractStructuredData",
+      kind,
+      pdfOcrForAnalyze,
+      docxInclude,
+      ocr,
+      analyzeFileOutput
+    );
+    return {
+      intent,
+      steps: [
+        ...sub.steps ?? [],
+        { id: "docmind_markdown_render", status: "planned" }
+      ]
+    };
+  }
   return planAnalyzeFile(kind, pdfOcrForAnalyze, docxInclude, ocr);
 }
 async function getCapabilities(input, options) {
@@ -1291,6 +1379,6 @@ async function explainAnalysisPlan(input, options) {
   return buildNodeExplainReport(kind, intent, pdfOcrAnalyze, plan, docxInc, ocrSlice);
 }
 
-export { DOCX_EMBEDDED_IMAGE_CAPABILITIES, DOCX_STRUCTURE_CAPABILITIES, analyzeFile, bufferToInput, convertToHtml, docxIncludeRequested, explainAnalysisPlan, extractMetadata, extractStructuredData, extractText, getCapabilities, readFileToInput, resolveNodeAnalyzeInput, runOcr };
+export { DOCX_EMBEDDED_IMAGE_CAPABILITIES, DOCX_STRUCTURE_CAPABILITIES, analyzeFile, bufferToInput, convertToHtml, docxIncludeRequested, explainAnalysisPlan, extractLlmContent, extractMarkdown, extractMetadata, extractStructuredChunks, extractStructuredData, extractText, getCapabilities, readFileToInput, resolveNodeAnalyzeInput, runOcr };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dragon708/docmind-node",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Official DocMind Node facade: analyzeFile, intent APIs, PDF/DOCX/OCR, and fs helpers.",
   "type": "module",
   "main": "./dist/index.js",
@@ -33,6 +33,7 @@
   "license": "MIT",
   "dependencies": {
     "@dragon708/docmind-docx": "^1.8.0",
+    "@dragon708/docmind-markdown": "^1.0.0",
     "@dragon708/docmind-ocr": "^1.1.4",
     "@dragon708/docmind-pdf": "^2.2.0",
     "@dragon708/docmind-shared": "^1.2.0"