md2x 0.7.4 → 0.7.6

package/dist/types/node/src/host/types.d.ts

@@ -0,0 +1,251 @@
+/**
+ * Core types for markdown conversion - Web Worker compatible
+ */
+import type { RendererThemeConfig } from '../../../src/types/index';
+export type { RendererThemeConfig };
+export type OutputFormat = 'docx' | 'pdf' | 'html' | 'png' | 'jpg' | 'jpeg' | 'webp';
+export type DiagramMode = 'img' | 'live' | 'none';
+export type FrontMatterData = Record<string, unknown>;
+export interface ImageOptions {
+    /** Output image type (default: "png") */
+    type?: 'png' | 'jpeg' | 'webp';
+    /** Image quality, 0-100 (only for jpeg/webp) */
+    quality?: number;
+    /**
+     * Clamp the output bitmap width (in physical pixels) by lowering the deviceScaleFactor.
+     * Default: 2000. Set to 0 to disable.
+     */
+    maxPixelWidth?: number;
+    /**
+     * Split very tall pages into multiple images.
+     * - `false`: always export a single image
+     * - `true`: always split when `fullPage: true`
+     * - `"auto"` (default): split only when the page is too tall
+     */
+    split?: boolean | 'auto';
+    /** Maximum slice height in physical pixels (default: 14000) */
+    splitMaxPixelHeight?: number;
+    /** Overlap between slices in CSS px (default: 0) */
+    splitOverlapPx?: number;
+    /** Capture the full scrollable page (default: true) */
+    fullPage?: boolean;
+    /** Capture a specific element instead of the full page (CSS selector) */
+    selector?: string | string[];
+    /** How to handle selectors that match multiple elements */
+    selectorMode?: 'first' | 'each' | 'union' | 'stitch';
+    /** Extra padding (CSS px) around the selected element */
+    selectorPadding?: number;
+    /** Vertical gap (CSS px) between elements when `selectorMode: "stitch"` */
+    selectorGap?: number;
+    /** Pre-scroll the page to trigger lazy-loading before taking a screenshot */
+    scrollToLoad?: boolean;
+    /** Fine-tune the scroll behavior when `scrollToLoad` is enabled */
+    scroll?: {
+        stepPx?: number;
+        delayMs?: number;
+        maxSteps?: number;
+        maxTimeMs?: number;
+    };
+    /** Omit the default white background (PNG only; default: false) */
+    omitBackground?: boolean;
+    /** Capture screenshot from the surface (GPU composited) or the view */
+    fromSurface?: boolean;
+    /** Capture beyond viewport setting */
+    captureBeyondViewport?: boolean;
+    /** Viewport settings */
+    viewport?: {
+        width?: number;
+        height?: number;
+        deviceScaleFactor?: number;
+    };
+}
+export interface PdfOptions {
+    format?: 'A4' | 'Letter' | 'Legal' | 'A3' | 'A5';
+    landscape?: boolean;
+    margin?: {
+        top?: string | number;
+        bottom?: string | number;
+        left?: string | number;
+        right?: string | number;
+    };
+    printBackground?: boolean;
+    scale?: number;
+    displayHeaderFooter?: boolean;
+    /** HTML template for the print header */
+    headerTemplate?: string;
+    /** HTML template for the print footer */
+    footerTemplate?: string;
+    /** Custom page width (e.g., '800px') */
+    width?: string;
+    /** Custom page height (e.g., '600px') */
+    height?: string;
+    /** Document title for header template */
+    title?: string;
+}
+export interface FrontMatterOptions {
+    theme?: string;
+    format?: OutputFormat;
+    hrAsPageBreak?: boolean;
+    image?: ImageOptions;
+    title?: string;
+    standalone?: boolean;
+    diagramMode?: DiagramMode;
+    baseTag?: boolean;
+    liveRuntime?: 'inline' | 'cdn';
+    liveRuntimeBaseUrl?: string;
+    cdn?: Partial<{
+        mermaid: string;
+        vue: string;
+        vueSfcLoader: string;
+        svelteCompiler: string;
+        svelteBase: string;
+    }>;
+    /**
+     * Pre-loaded md2x template sources, keyed by template ref.
+     *
+     * Common keys:
+     * - "vue/my-component.vue"
+     * - "svelte/my-widget.svelte"
+     * - "html/my-template.html"
+     *
+     * You may also include the raw `template:` value (e.g. "my-component.vue") as an additional key.
+     */
+    templates?: Record<string, string>;
+    pdf?: PdfOptions;
+}
+export interface CdnOptions {
+    /** CDN base URL for md2x runtime (default: jsdelivr) */
+    runtimeBaseUrl?: string;
+    /** Mermaid CDN URL */
+    mermaidUrl?: string;
+    /** md2x package version for CDN */
+    md2xVersion?: string;
+    /** CDN overrides for diagram libraries */
+    cdn?: Partial<{
+        mermaid: string;
+        vue: string;
+        vueSfcLoader: string;
+        svelteCompiler: string;
+        svelteBase: string;
+    }>;
+}
+export interface MarkdownToHtmlStringOptions {
+    title?: string;
+    /** Theme ID (e.g., 'default', 'academic') */
+    theme?: string;
+    /** KaTeX version for CDN */
+    katexVersion?: string;
+    /** Additional CSS to inject */
+    css?: string;
+    /** Additional head content (e.g., custom stylesheets) */
+    head?: string;
+    /** Enable live diagram rendering (mermaid, graphviz, etc.) */
+    liveDiagrams?: boolean;
+    /** CDN URL options */
+    cdn?: CdnOptions;
+    /** Treat hr as page break */
+    hrAsPageBreak?: boolean;
+    /** Base href for resolving relative URLs */
+    baseHref?: string;
+    /** Theme config for renderers */
+    themeConfig?: RendererThemeConfig | null;
+    /** Pre-loaded md2x template files */
+    md2xTemplateFiles?: Record<string, string>;
+}
+export interface RenderResult {
+    base64: string;
+    width: number;
+    height: number;
+    format: string;
+}
+export interface BrowserRenderer {
+    initialize(): Promise<void>;
+    render(type: string, content: string | object, basePath?: string, themeConfig?: RendererThemeConfig | null): Promise<RenderResult | null>;
+    exportToPdf(html: string, css: string, options?: PdfOptions, basePath?: string): Promise<Buffer>;
+    exportToImage(html: string, css: string, options?: ImageOptions, basePath?: string): Promise<Buffer>;
+    exportToImageParts(html: string, css: string, options?: ImageOptions, basePath?: string): Promise<Buffer[]>;
+    close(): Promise<void>;
+}
+export interface Md2xTemplateConfig {
+    template: string;
+    type: 'vue' | 'html' | 'svelte';
+    data: any;
+}
+export interface Md2xBaseOptions {
+    theme?: string;
+    basePath?: string;
+    /** When true, horizontal rules will be converted to page breaks in print/PDF */
+    hrAsPageBreak?: boolean;
+    /** Diagram/template rendering mode: "img" | "live" | "none" */
+    diagramMode?: DiagramMode;
+    /** Pre-loaded md2x template sources */
+    templates?: Record<string, string>;
+}
+export interface Md2DocxOptions extends Md2xBaseOptions {
+}
+export interface Md2PdfOptions extends Md2xBaseOptions {
+    pdf?: PdfOptions;
+    /** CDN overrides for live mode */
+    cdn?: Md2HtmlOptions['cdn'];
+}
+export interface Md2ImageOptions extends Md2xBaseOptions {
+    image?: ImageOptions;
+    /** CDN overrides for live diagram mode */
+    cdn?: Md2HtmlOptions['cdn'];
+}
+export interface Md2HtmlOptions extends Md2xBaseOptions {
+    /** Document title for standalone HTML output */
+    title?: string;
+    /** When true, returns a full HTML document with embedded CSS (default: true) */
+    standalone?: boolean;
+    /** Live diagram runtime injection strategy: "inline" | "cdn" */
+    liveRuntime?: 'inline' | 'cdn';
+    /** Custom runtime base URL when `liveRuntime: "cdn"` */
+    liveRuntimeBaseUrl?: string;
+    /** Optional CDN overrides */
+    cdn?: Partial<{
+        mermaid: string;
+        vue: string;
+        vueSfcLoader: string;
+        svelteCompiler: string;
+        svelteBase: string;
+    }>;
+    /** When true, emit a `<base href="file://.../">` tag (default: true) */
+    baseTag?: boolean;
+}
+export type NodePlatformOutput = {
+    kind: 'buffer';
+} | {
+    kind: 'file';
+};
+export interface CreateNodePlatformOptions {
+    /** Directory of the running Node module */
+    moduleDir: string;
+    selectedThemeId: string;
+    output: NodePlatformOutput;
+    /** Settings to pass to exporters via storage */
+    settings?: {
+        docxHrAsPageBreak?: boolean;
+    };
+}
+export interface CreatedNodePlatform {
+    platform: import('../../../src/types/index').PlatformAPI;
+    getCapturedBuffer: () => Buffer | null;
+}
+/** Alias for FrontMatterOptions, used as conversion options */
+export type ConvertOptions = FrontMatterOptions & {
+    basePath?: string;
+    /** Skip front matter parsing (use when markdown is already stripped of front matter) */
+    skipFrontMatter?: boolean;
+};
+export interface ConvertResult {
+    /** Output buffer */
+    buffer: Buffer;
+    /** Resolved output path */
+    outputPath: string;
+    /** Multiple parts for image format with splitting enabled */
+    buffers?: Buffer[];
+    outputPaths?: string[];
+    /** Output format used */
+    format: OutputFormat;
+}

package/dist/types/node/src/index.d.ts

@@ -1,4 +1,3 @@
 export { NodeDocxExporter, NodeHtmlExporter, NodePdfExporter, NodeImageExporter } from './host/node-exporter';
-export type { Md2DocxOptions, Md2HtmlOptions, Md2PdfOptions, Md2ImageOptions } from './host/node-exporter';
-export type { PdfOptions, ImageOptions } from './host/browser-renderer';
-export { type OutputFormat, type DiagramMode, type FrontMatterOptions, type ConvertOptions, type ConvertResult, parseFrontMatter, frontMatterToOptions, markdownToDocxBuffer, markdownToPdfBuffer, markdownToHtmlString, markdownToHtmlBuffer, markdownToImageBuffer, markdownToImageBuffers, convert, convertFile, } from './host/index';
+export type { OutputFormat, DiagramMode, FrontMatterData, FrontMatterOptions, ImageOptions, PdfOptions, MarkdownToHtmlStringOptions, CdnOptions, ConvertOptions, ConvertResult, Md2xTemplateConfig, Md2xBaseOptions, Md2DocxOptions, Md2PdfOptions, Md2ImageOptions, Md2HtmlOptions, RenderResult, BrowserRenderer, NodePlatformOutput, CreateNodePlatformOptions, CreatedNodePlatform, } from './host/types';
+export { parseFrontMatter, frontMatterToOptions, markdownToHtml, markdownToStandaloneHtml, markdownToDocxBuffer, markdownToPdfBuffer, markdownToHtmlString, markdownToHtmlBuffer, markdownToImageBuffer, markdownToImageBuffers, convert, convertFile, } from './host/index';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "md2x",
-  "version": "0.7.4",
+  "version": "0.7.6",
   "description": "Markdown converter (local, no server). Supports Mermaid/Graphviz/Vega/HTML/SVG rendering, math, and code highlighting.",
   "type": "module",
   "private": false,
@@ -16,13 +16,21 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./core-worker": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/core-worker.js"
+    },
+    "./core-worker-browser": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/renderer/core-worker-browser.js"
     }
   },
   "scripts": {
     "build": "node build.mjs",
     "dev": "node build.mjs --watch --run",
     "cli": "node dist/md2x.js",
-    "test": "node --test test/*.test.mjs",
+    "test": "node --test test/*.test.mjs && node test/scripts/cleanup-out.mjs",
     "prepublishOnly": "node build.mjs"
   },
   "keywords": [
@@ -48,8 +56,10 @@
     "node": ">=18"
   },
   "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.25.3",
     "js-yaml": "^4.1.1",
-    "puppeteer": "24.35.0"
+    "puppeteer": "24.35.0",
+    "zod": "^4.3.6"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9"

package/dist/chunks/chunk-2LPNL4GA.js

@@ -1 +0,0 @@
-import{b as I}from"./chunk-MHCTK6WW.js";import{b as R,d as Y}from"./chunk-NM6J3ND7.js";var k=R((Q,F)=>{"use strict";var m=Object.prototype.hasOwnProperty,D=Object.prototype.toString,T=Object.defineProperty,C=Object.getOwnPropertyDescriptor,S=function(e){return typeof Array.isArray=="function"?Array.isArray(e):D.call(e)==="[object Array]"},j=function(e){if(!e||D.call(e)!=="[object Object]")return!1;var t=m.call(e,"constructor"),r=e.constructor&&e.constructor.prototype&&m.call(e.constructor.prototype,"isPrototypeOf");if(e.constructor&&!t&&!r)return!1;var i;for(i in e);return typeof i>"u"||m.call(e,i)},V=function(e,t){T&&t.name==="__proto__"?T(e,t.name,{enumerable:!0,configurable:!0,value:t.newValue,writable:!0}):e[t.name]=t.newValue},_=function(e,t){if(t==="__proto__")if(m.call(e,t)){if(C)return C(e,t).value}else return;return e[t]};F.exports=function n(){var e,t,r,i,a,c,o=arguments[0],p=1,s=arguments.length,f=!1;for(typeof o=="boolean"&&(f=o,o=arguments[1]||{},p=2),(o==null||typeof o!="object"&&typeof o!="function")&&(o={});p<s;++p)if(e=arguments[p],e!=null)for(t in e)r=_(o,t),i=_(e,t),o!==i&&(f&&i&&(j(i)||(a=S(i)))?(a?(a=!1,c=r&&S(r)?r:[]):c=r&&j(r)?r:{},V(o,{name:t,newValue:n(f,c,i)})):typeof i<"u"&&V(o,{name:t,newValue:i}));return o}});function b(n){if(n)throw n}var g=Y(k(),1);function d(n){if(typeof n!="object"||n===null)return!1;let e=Object.getPrototypeOf(n);return(e===null||e===Object.prototype||Object.getPrototypeOf(e)===null)&&!(Symbol.toStringTag in n)&&!(Symbol.iterator in n)}function x(){let n=[],e={run:t,use:r};return e;function t(...i){let a=-1,c=i.pop();if(typeof c!="function")throw new TypeError("Expected function as last argument, not "+c);o(null,...i);function o(p,...s){let f=n[++a],u=-1;if(p){c(p);return}for(;++u<i.length;)(s[u]===null||s[u]===void 0)&&(s[u]=i[u]);i=s,f?L(f,o)(...s):c(null,...s)}}function r(i){if(typeof i!="function")throw new TypeError("Expected `middelware` to be a function, not "+i);return n.push(i),e}}function L(n,e){let t;return r;function r(...c){let o=n.length>c.length,p;o&&c.push(i);try{p=n.apply(this,c)}catch(s){let f=s;if(o&&t)throw f;return i(f)}o||(p&&p.then&&typeof p.then=="function"?p.then(a,i):p instanceof Error?i(p):a(p))}function i(c,...o){t||(t=!0,e(c,...o))}function a(c){i(null,c)}}var N=(function(n){let r=this.constructor.prototype,i=r[n],a=function(){return i.apply(a,arguments)};return Object.setPrototypeOf(a,r),a});var q={}.hasOwnProperty,z=class n extends N{constructor(){super("copy"),this.Compiler=void 0,this.Parser=void 0,this.attachers=[],this.compiler=void 0,this.freezeIndex=-1,this.frozen=void 0,this.namespace={},this.parser=void 0,this.transformers=x()}copy(){let e=new n,t=-1;for(;++t<this.attachers.length;){let r=this.attachers[t];e.use(...r)}return e.data((0,g.default)(!0,{},this.namespace)),e}data(e,t){return typeof e=="string"?arguments.length===2?(E("data",this.frozen),this.namespace[e]=t,this):q.call(this.namespace,e)&&this.namespace[e]||void 0:e?(E("data",this.frozen),this.namespace=e,this):this.namespace}freeze(){if(this.frozen)return this;let e=this;for(;++this.freezeIndex<this.attachers.length;){let[t,...r]=this.attachers[this.freezeIndex];if(r[0]===!1)continue;r[0]===!0&&(r[0]=void 0);let i=t.call(e,...r);typeof i=="function"&&this.transformers.use(i)}return this.frozen=!0,this.freezeIndex=Number.POSITIVE_INFINITY,this}parse(e){this.freeze();let t=w(e),r=this.parser||this.Parser;return P("parse",r),r(String(t),t)}process(e,t){let r=this;return this.freeze(),P("process",this.parser||this.Parser),O("process",this.compiler||this.Compiler),t?i(void 0,t):new Promise(i);function i(a,c){let o=w(e),p=r.parse(o);r.run(p,o,function(f,u,l){if(f||!u||!l)return s(f);let h=u,y=r.stringify(h,l);J(y)?l.value=y:l.result=y,s(f,l)});function s(f,u){f||!u?c(f):a?a(u):t(void 0,u)}}}processSync(e){let t=!1,r;return this.freeze(),P("processSync",this.parser||this.Parser),O("processSync",this.compiler||this.Compiler),this.process(e,i),B("processSync","process",t),r;function i(a,c){t=!0,b(a),r=c}}run(e,t,r){U(e),this.freeze();let i=this.transformers;return!r&&typeof t=="function"&&(r=t,t=void 0),r?a(void 0,r):new Promise(a);function a(c,o){let p=w(t);i.run(e,p,s);function s(f,u,l){let h=u||e;f?o(f):c?c(h):r(void 0,h,l)}}}runSync(e,t){let r=!1,i;return this.run(e,t,a),B("runSync","run",r),i;function a(c,o){b(c),i=o,r=!0}}stringify(e,t){this.freeze();let r=w(t),i=this.compiler||this.Compiler;return O("stringify",i),U(e),i(e,r)}use(e,...t){let r=this.attachers,i=this.namespace;if(E("use",this.frozen),e!=null)if(typeof e=="function")p(e,t);else if(typeof e=="object")Array.isArray(e)?o(e):c(e);else throw new TypeError("Expected usable value, not `"+e+"`");return this;function a(s){if(typeof s=="function")p(s,[]);else if(typeof s=="object")if(Array.isArray(s)){let[f,...u]=s;p(f,u)}else c(s);else throw new TypeError("Expected usable value, not `"+s+"`")}function c(s){if(!("plugins"in s)&&!("settings"in s))throw new Error("Expected usable value but received an empty preset, which is probably a mistake: presets typically come with `plugins` and sometimes with `settings`, but this has neither");o(s.plugins),s.settings&&(i.settings=(0,g.default)(!0,i.settings,s.settings))}function o(s){let f=-1;if(s!=null)if(Array.isArray(s))for(;++f<s.length;){let u=s[f];a(u)}else throw new TypeError("Expected a list of plugins, not `"+s+"`")}function p(s,f){let u=-1,l=-1;for(;++u<r.length;)if(r[u][0]===s){l=u;break}if(l===-1)r.push([s,...f]);else if(f.length>0){let[h,...y]=f,A=r[l][1];d(A)&&d(h)&&(h=(0,g.default)(!0,A,h)),r[l]=[s,h,...y]}}}},G=new z().freeze();function P(n,e){if(typeof e!="function")throw new TypeError("Cannot `"+n+"` without `parser`")}function O(n,e){if(typeof e!="function")throw new TypeError("Cannot `"+n+"` without `compiler`")}function E(n,e){if(e)throw new Error("Cannot call `"+n+"` on a frozen processor.\nCreate a new processor first, by calling it: use `processor()` instead of `processor`.")}function U(n){if(!d(n)||typeof n.type!="string")throw new TypeError("Expected node, got `"+n+"`")}function B(n,e,t){if(!t)throw new Error("`"+n+"` finished async. Use `"+e+"` instead")}function w(n){return H(n)?n:new I(n)}function H(n){return!!(n&&typeof n=="object"&&"message"in n&&"messages"in n)}function J(n){return typeof n=="string"||K(n)}function K(n){return!!(n&&typeof n=="object"&&"byteLength"in n&&"byteOffset"in n)}export{G as a};