@speajus/markdown-to-pdf 1.0.13 → 1.0.15

package/README.md

@@ -2,7 +2,7 @@
 
 A lightweight TypeScript library that converts Markdown files into styled PDF documents. Built on [marked](https://github.com/markedjs/marked) for parsing and [PDFKit](https://pdfkit.org/) for PDF generation. [README.pdf](./README.pdf) | [Live Demo](https://speajus.github.io/markdown-to-pdf/)
 
-[![Live Demo](./docs/image.png)](https://speajus.github.io/markdown-to-pdf/)
+-[![Live Demo](./docs/image.png)]([https://speajus.github.io/markdown-to-pdf/](https://speajus.github.io/markdown-to-pdf/))
 
 ## Features
 
@@ -128,16 +128,16 @@ await generatePdf(markdown, {
 
 The full `ThemeConfig` interface exposes styles for:
 
-| Section        | Configurable properties                             |
-| -------------- | --------------------------------------------------- |
-| `headings`     | Font, size, and color for each level (h1–h6)        |
-| `body`         | Font, size, color, and line gap                     |
-| `code.inline`  | Font, size, color, and background color              |
-| `code.block`   | Font, size, color, background color, and padding     |
-| `blockquote`   | Border color, border width, italic flag, and indent  |
-| `table`        | Header background, border color, cell padding, and zebra color |
-| `linkColor`    | Color for hyperlink text                             |
-| `horizontalRuleColor` | Color for `---` dividers                      |
+| Section | Configurable properties |
+| --- | --- |
+| headings | Font, size, and color for each level (h1–h6) |
+| body | Font, size, color, and line gap |
+| code.inline | Font, size, color, and background color |
+| code.block | Font, size, color, background color, and padding |
+| blockquote | Border color, border width, italic flag, and indent |
+| table | Header background, border color, cell padding, and zebra color |
+| linkColor | Color for hyperlink text |
+| horizontalRuleColor | Color for --- dividers |
 
 ## Project Structure
 
@@ -163,18 +163,18 @@ The full `ThemeConfig` interface exposes styles for:
 ## Dependencies
 
 | Package | Purpose |
-| ------- | ------- |
-| [marked](https://github.com/markedjs/marked) | Markdown parsing and tokenization |
-| [pdfkit](https://pdfkit.org/) | PDF document generation |
-| [@resvg/resvg-js](https://github.com/nicolo-ribaudo/resvg-js) | SVG-to-PNG rasterization for image embedding |
+| --- | --- |
+| marked | Markdown parsing and tokenization |
+| pdfkit | PDF document generation |
+| @resvg/resvg-js | SVG-to-PNG rasterization for image embedding |
 
 ## Scripts
 
 | Command | Description |
-| ------- | ----------- |
-| `npm run build` | Compile TypeScript to `dist/` |
-| `npm run generate` | Generate sample PDFs from `samples/*.md` into `output/` |
+| --- | --- |
+| npm run build | Compile TypeScript to dist/ |
+| npm run generate | Generate sample PDFs from samples/*.md into output/ |
 
 ## License
 
-ISC
+ISC

package/dist/cli.js

@@ -9,6 +9,9 @@ const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const index_js_1 = require("./index.js");
 async function readMdWritePdf(inputPath, outputPath, extraOptions) {
+    if (inputPath === outputPath) {
+        throw new Error(`input path can not be the same as output path.`);
+    }
     console.log(`Converting ${inputPath} → ${outputPath}`);
     const resolvedInput = path_1.default.resolve(inputPath);
     const markdown = fs_1.default.readFileSync(resolvedInput, "utf-8");

package/dist/renderer.js

@@ -14,6 +14,13 @@ const emoji_js_1 = require("./emoji.js");
 const color_emoji_js_1 = require("./color-emoji.js");
 /** Name used to register the emoji font with PDFKit */
 const EMOJI_FONT_NAME = 'NotoEmoji';
+/** Standard PDF fonts built into PDFKit — always available without filesystem access. */
+const STANDARD_PDF_FONTS = new Set([
+    'Helvetica', 'Helvetica-Bold', 'Helvetica-Oblique', 'Helvetica-BoldOblique',
+    'Courier', 'Courier-Bold', 'Courier-Oblique', 'Courier-BoldOblique',
+    'Times-Roman', 'Times-Bold', 'Times-Italic', 'Times-BoldItalic',
+    'Symbol', 'ZapfDingbats',
+]);
 async function renderMarkdownToPdf(markdown, options) {
     const theme = options?.theme ?? styles_js_1.defaultTheme;
     const layout = options?.pageLayout ?? styles_js_1.defaultPageLayout;
@@ -87,6 +94,20 @@ async function renderMarkdownToPdf(markdown, options) {
             }
         }
     }
+    // ── Browser font safety ────────────────────────────────────────────────
+    // In browser environments, `fs.readFileSync` doesn't exist.  When PDFKit
+    // encounters an unknown font name it tries to load it from disk via
+    // readFileSync, which crashes in the browser.  Detect whether we're in a
+    // filesystem-capable environment so we can guard calls to `doc.font()`.
+    let fsAvailable = false;
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
+        const nodeFs = require('fs');
+        fsAvailable = typeof nodeFs.readFileSync === 'function';
+    }
+    catch {
+        // Node.js `fs` not available — we're in a browser environment.
+    }
     // ── Color emoji pre-render ─────────────────────────────────────────────
     // When a colorEmoji renderer is provided, pre-scan the entire markdown for
     // every unique emoji and convert them all to PNG buffers up-front.  This
@@ -122,6 +143,38 @@ async function renderMarkdownToPdf(markdown, options) {
             return customFontNames.has(font.substring(0, dash));
         return false;
     }
+    /**
+     * Return a safe font name that will not crash `doc.font()`.
+     *
+     * In Node.js (`fsAvailable === true`) this is a no-op — PDFKit can load
+     * fonts from the filesystem.  In browser environments, if the font is
+     * neither a standard PDF font nor a registered custom / emoji font, we
+     * return a standard fallback and log a warning so the user knows which
+     * font was unavailable.
+     */
+    function safeFont(name) {
+        if (fsAvailable)
+            return name;
+        if (STANDARD_PDF_FONTS.has(name) || isCustomFont(name) || name === EMOJI_FONT_NAME)
+            return name;
+        // Determine the closest standard fallback, preserving bold/italic intent
+        // by inspecting the variant suffix added by resolveFont().
+        let fallback;
+        if (name.endsWith('-BoldOblique') || name.endsWith('-BoldItalic')) {
+            fallback = 'Helvetica-BoldOblique';
+        }
+        else if (name.endsWith('-Bold')) {
+            fallback = 'Helvetica-Bold';
+        }
+        else if (name.endsWith('-Oblique') || name.endsWith('-Italic')) {
+            fallback = 'Helvetica-Oblique';
+        }
+        else {
+            fallback = 'Helvetica';
+        }
+        console.warn(`[markdown-to-pdf] Font "${name}" is not available; falling back to "${fallback}"`);
+        return fallback;
+    }
     /** Return the base (registered) name of a custom font, stripping any variant suffix. */
     function customFontBase(font) {
         if (customFontNames.has(font))
@@ -190,18 +243,18 @@ async function renderMarkdownToPdf(markdown, options) {
             let font = headingCtx.font;
             if (bold || italic)
                 font = resolveFont(font, bold, italic);
-            doc.font(font).fontSize(headingCtx.fontSize).fillColor(headingCtx.color);
+            doc.font(safeFont(font)).fontSize(headingCtx.fontSize).fillColor(headingCtx.color);
             return;
         }
         const font = resolveFont(theme.body.font, bold, italic);
-        doc.font(font).fontSize(theme.body.fontSize).fillColor(theme.body.color);
+        doc.font(safeFont(font)).fontSize(theme.body.fontSize).fillColor(theme.body.color);
     }
     function resetBodyFont() {
         if (headingCtx) {
-            doc.font(headingCtx.font).fontSize(headingCtx.fontSize).fillColor(headingCtx.color);
+            doc.font(safeFont(headingCtx.font)).fontSize(headingCtx.fontSize).fillColor(headingCtx.color);
             return;
         }
-        doc.font(theme.body.font).fontSize(theme.body.fontSize).fillColor(theme.body.color);
+        doc.font(safeFont(theme.body.font)).fontSize(theme.body.fontSize).fillColor(theme.body.color);
     }
     /**
      * Render a text string switching to the emoji font for emoji characters.
@@ -249,7 +302,7 @@ async function renderMarkdownToPdf(markdown, options) {
             return;
         }
         // Remember the caller's font state so we can restore after emoji runs.
-        const prevFont = doc._font?.name ?? theme.body.font;
+        const prevFont = doc._font?.name ?? safeFont(theme.body.font);
         const prevSize = doc._fontSize ?? theme.body.fontSize;
         const segments = (0, emoji_js_1.splitEmojiSegments)(text);
         // ── Color emoji path: render emoji as inline PNG images ──────────────
@@ -399,7 +452,7 @@ async function renderMarkdownToPdf(markdown, options) {
         const cs = theme.code.inline;
         const hPad = 2; // horizontal padding each side
         const vPad = 1; // vertical padding each side
-        doc.font(cs.font).fontSize(cs.fontSize);
+        doc.font(safeFont(cs.font)).fontSize(cs.fontSize);
         const textW = doc.widthOfString(text);
         const textH = doc.currentLineHeight();
         // Determine flow position.  If this is the first output in a table cell,
@@ -429,7 +482,7 @@ async function renderMarkdownToPdf(markdown, options) {
             .fill(cs.backgroundColor);
         doc.restore();
         // Render inline — use positioned form for cell context, flow form otherwise
-        doc.font(cs.font).fontSize(cs.fontSize).fillColor(cs.color);
+        doc.font(safeFont(cs.font)).fontSize(cs.fontSize).fillColor(cs.color);
         if (useCellPos) {
             doc.text(text, flowX, flowY, { continued, ...cellExtra });
         }
@@ -445,10 +498,10 @@ async function renderMarkdownToPdf(markdown, options) {
             return renderImage(imgChild, tok.href);
         }
         if (headingCtx) {
-            doc.font(headingCtx.font).fontSize(headingCtx.fontSize).fillColor(theme.linkColor);
+            doc.font(safeFont(headingCtx.font)).fontSize(headingCtx.fontSize).fillColor(theme.linkColor);
         }
         else {
-            doc.font(theme.body.font).fontSize(theme.body.fontSize).fillColor(theme.linkColor);
+            doc.font(safeFont(theme.body.font)).fontSize(theme.body.fontSize).fillColor(theme.linkColor);
         }
         const linkText = tok.text || tok.href;
         renderTextWithEmoji(linkText, { continued, underline: true, link: tok.href });
@@ -666,7 +719,7 @@ async function renderMarkdownToPdf(markdown, options) {
                 const spaceBelow = style.fontSize * 0.3;
                 ensureSpace(spaceAbove + style.fontSize + spaceBelow);
                 doc.moveDown(spaceAbove / doc.currentLineHeight());
-                doc.font(style.font).fontSize(style.fontSize).fillColor(style.color);
+                doc.font(safeFont(style.font)).fontSize(style.fontSize).fillColor(style.color);
                 headingCtx = style;
                 if (t.tokens && t.tokens.length > 0) {
                     await renderInlineTokens(t.tokens, false, style.bold ?? false, style.italic ?? false);
@@ -712,7 +765,7 @@ async function renderMarkdownToPdf(markdown, options) {
                         x: margins.left,
                         y: doc.y,
                         width: contentWidth,
-                        font: cs.font,
+                        font: safeFont(cs.font),
                         fontSize: cs.fontSize,
                         lineHeight: 1.5,
                         padding: cs.padding,
@@ -736,7 +789,7 @@ async function renderMarkdownToPdf(markdown, options) {
                     doc.save();
                     doc.rect(x, y, contentWidth, blockH).fill(cs.backgroundColor);
                     doc.restore();
-                    doc.font(cs.font).fontSize(cs.fontSize).fillColor(cs.color);
+                    doc.font(safeFont(cs.font)).fontSize(cs.fontSize).fillColor(cs.color);
                     let textY = y + cs.padding;
                     for (const line of lines) {
                         doc.text(line, x + cs.padding, textY, { width: contentWidth - cs.padding * 2 });
@@ -762,7 +815,7 @@ async function renderMarkdownToPdf(markdown, options) {
                     if (child.type === 'paragraph') {
                         const p = child;
                         const font = bq.italic ? italicVariant(theme.body.font) : theme.body.font;
-                        doc.font(font).fontSize(theme.body.fontSize).fillColor(theme.body.color);
+                        doc.font(safeFont(font)).fontSize(theme.body.fontSize).fillColor(theme.body.color);
                         doc.text('', textX, doc.y, { width: textWidth });
                         await renderInlineTokens(p.tokens, false, false, bq.italic);
                         doc.moveDown(0.3);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speajus/markdown-to-pdf",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "description": "A new project created with Intent by Augment.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,9 +29,11 @@
     "README.md"
   ],
   "scripts": {
+    "docs:dev": "cd docs && $npm_execpath dev",
     "build": "tsc && mkdir -p dist/fonts && cp src/fonts/* dist/fonts/",
     "generate": "tsx samples/generate.ts",
-    "test": "tsx --test test/*.test.ts && tsx samples/generate.ts && tsx ./src/cli.ts README.md README.pdf"
+    "readme": "pnpm tsx ./src/cli.ts README.md README.pdf",
+    "test": "tsx --test test/*.test.ts && tsx samples/generate.ts && pnpm run readme"
   },
   "keywords": [
     "markdown",