@bobfrankston/brother-label 1.0.14 → 1.1.2

package/render.ts

@@ -1,280 +1,29 @@
-/**
- * HTML to bitmap rendering module
- * Standalone utility for converting HTML to PNG images
- */
-
-import puppeteer, { Browser } from "puppeteer";
-import * as path from "path";
-import * as fs from "fs";
-import { Jimp } from "jimp";
-import QRCode from "qrcode";
-
-export interface RenderOptions {
-    width?: number;              // If omitted or 0, auto-detect from content
-    height: number;              // Target output height in pixels (300 DPI)
-    tapeMm?: number;             // Tape size in mm - if set, viewport matches CSS mm interpretation
-    deviceScaleFactor?: number;  // Default 3 for high quality (288 DPI effective)
-    keepScale?: boolean;         // If true, don't scale down - keep full resolution output
-}
-
-let browserInstance: Browser | null = null;
-
-const DEFAULT_SCALE = 3;  // Render at 3x for quality, then scale down
-const CSS_DPI = 96;       // CSS interprets mm at 96 DPI
-const MM_PER_INCH = 25.4;
-
-/**
- * Generate QR code data URLs for all qr attributes found in page
- * Returns map of qr data -> data URL
- */
-async function generateQrDataUrls(qrValues: string[]): Promise<Map<string, string>> {
-    const map = new Map<string, string>();
-    for (const data of qrValues) {
-        if (!map.has(data)) {
-            const dataUrl = await QRCode.toDataURL(data, {
-                type: "image/png",
-                margin: 0,
-                errorCorrectionLevel: "M",
-                color: { dark: "#000000", light: "#ffffff" },
-            });
-            map.set(data, dataUrl);
-        }
-    }
-    return map;
-}
-
-/**
- * Process <img qr="..."> elements in page via DOM manipulation
- */
-async function processQrElements(page: puppeteer.Page): Promise<void> {
-    // Get all qr attribute values from the page
-    const qrValues = await page.evaluate(() => {
-        const imgs = document.querySelectorAll("img[qr]");
-        return Array.from(imgs).map(img => img.getAttribute("qr") || "");
-    });
-
-    if (qrValues.length === 0) return;
-
-    // Generate QR codes
-    const qrMap = await generateQrDataUrls(qrValues);
-
-    // Convert map to object for passing to page context
-    const qrUrls: Record<string, string> = {};
-    qrMap.forEach((url, data) => { qrUrls[data] = url; });
-
-    // Replace qr attributes with src in the DOM
-    await page.evaluate((urls: Record<string, string>) => {
-        const imgs = document.querySelectorAll("img[qr]");
-        imgs.forEach(img => {
-            const qrData = img.getAttribute("qr");
-            if (qrData && urls[qrData]) {
-                img.setAttribute("src", urls[qrData]);
-                img.removeAttribute("qr");
-            }
-        });
-    }, qrUrls);
-}
-
-/**
- * Scale image buffer down to target dimensions
- */
-async function scaleDown(buffer: Buffer, targetWidth: number, targetHeight: number): Promise<Buffer> {
-    const image = await Jimp.read(buffer);
-    image.resize({ w: targetWidth, h: targetHeight });
-    return image.getBuffer("image/png");
-}
-
-/**
- * Get or create a shared browser instance for better performance
- */
-async function getBrowser(): Promise<Browser> {
-    if (!browserInstance || !browserInstance.connected) {
-        browserInstance = await puppeteer.launch({ headless: true });
-    }
-    return browserInstance;
-}
-
-/**
- * Close the shared browser instance
- */
-export async function closeBrowser(): Promise<void> {
-    if (browserInstance) {
-        await browserInstance.close();
-        browserInstance = null;
-    }
-}
-
-/**
- * Render HTML file to PNG buffer
- * Processes <img qr="..."> tags to inline base64 QR codes
- */
-export async function renderHtmlFile(htmlPath: string, options: RenderOptions): Promise<Buffer> {
-    const absolutePath = path.resolve(htmlPath);
-    if (!fs.existsSync(absolutePath)) {
-        throw new Error(`HTML file not found: ${absolutePath}`);
-    }
-    return renderHtmlUrl(`file://${absolutePath}`, options);
-}
-
-/**
- * Render HTML string to PNG buffer
- * Processes <img qr="..."> tags to inline base64 QR codes via DOM
- * @param html - HTML content string
- * @param options - Render dimensions (width auto-detected if omitted)
- * @param basePath - Optional base path for resolving relative resources
- */
-export async function renderHtmlString(html: string, options: RenderOptions, basePath?: string): Promise<Buffer> {
-    const browser = await getBrowser();
-    const page = await browser.newPage();
-    const scaleFactor = options.deviceScaleFactor ?? DEFAULT_SCALE;
-    const autoWidth = !options.width || options.width === 0;
-
-    // If tapeMm provided, use CSS-equivalent viewport height; otherwise use target height directly
-    const cssHeight = options.tapeMm
-        ? Math.round(options.tapeMm * CSS_DPI / MM_PER_INCH)
-        : options.height;
-    const targetHeight = options.height;
-
-    try {
-        // Use large initial width for auto-detection, or specified width
-        const initialWidth = autoWidth ? 4000 : options.width!;
-        await page.setViewport({
-            width: initialWidth,
-            height: cssHeight,
-            deviceScaleFactor: scaleFactor,
-        });
-
-        if (basePath) {
-            // Set base URL for relative resource resolution
-            const baseUrl = `file://${path.resolve(basePath)}/`;
-            await page.goto(baseUrl, { waitUntil: "domcontentloaded" });
-            await page.setContent(html, { waitUntil: "networkidle0" });
-        } else {
-            await page.setContent(html, { waitUntil: "networkidle0" });
-        }
-
-        // Process <img qr="..."> elements
-        await processQrElements(page);
-
-        // Auto-detect content width if needed
-        let finalCssWidth = initialWidth;
-        if (autoWidth) {
-            finalCssWidth = await page.evaluate(() => {
-                // Try first child of body (likely the main container)
-                const firstChild = document.body.firstElementChild as HTMLElement;
-                if (firstChild) {
-                    const rect = firstChild.getBoundingClientRect();
-                    if (rect.width > 0 && rect.width < 3000) {
-                        return Math.ceil(rect.width);
-                    }
-                }
-                // Fall back to scroll width (actual content width)
-                return document.body.scrollWidth;
-            });
-            await page.setViewport({
-                width: finalCssWidth,
-                height: cssHeight,
-                deviceScaleFactor: scaleFactor,
-            });
-        }
-
-        const pngBuffer = await page.screenshot({ type: "png" });
-
-        // Scale to target dimensions
-        // If tapeMm was used, scale from CSS dimensions to target 300 DPI dimensions
-        const scale = targetHeight / cssHeight;
-        const finalWidth = Math.round(finalCssWidth * scale);
-
-        if (scaleFactor > 1 || options.tapeMm) {
-            return scaleDown(Buffer.from(pngBuffer), finalWidth, targetHeight);
-        }
-        return Buffer.from(pngBuffer);
-    } finally {
-        await page.close();
-    }
-}
-
-/**
- * Render HTML from URL to PNG buffer
- * Processes <img qr="..."> tags to inline base64 QR codes via DOM
- * If width is not specified, auto-detects from content
- */
-export async function renderHtmlUrl(url: string, options: RenderOptions): Promise<Buffer> {
-    const browser = await getBrowser();
-    const page = await browser.newPage();
-    const scaleFactor = options.deviceScaleFactor ?? DEFAULT_SCALE;
-    const autoWidth = !options.width || options.width === 0;
-
-    // If tapeMm provided, use CSS-equivalent viewport height; otherwise use target height directly
-    const cssHeight = options.tapeMm
-        ? Math.round(options.tapeMm * CSS_DPI / MM_PER_INCH)
-        : options.height;
-    const targetHeight = options.height;
-
-    try {
-        // Use large initial width for auto-detection, or specified width
-        const initialWidth = autoWidth ? 4000 : options.width!;
-        await page.setViewport({
-            width: initialWidth,
-            height: cssHeight,
-            deviceScaleFactor: scaleFactor,
-        });
-
-        await page.goto(url, { waitUntil: "networkidle0" });
-
-        // Process <img qr="..."> elements
-        await processQrElements(page);
-
-        // Auto-detect content width if needed
-        let finalCssWidth = initialWidth;
-        if (autoWidth) {
-            finalCssWidth = await page.evaluate(() => {
-                // Try first child of body (likely the main container)
-                const firstChild = document.body.firstElementChild as HTMLElement;
-                if (firstChild) {
-                    const rect = firstChild.getBoundingClientRect();
-                    if (rect.width > 0 && rect.width < 3000) {
-                        return Math.ceil(rect.width);
-                    }
-                }
-                // Fall back to scroll width (actual content width)
-                return document.body.scrollWidth;
-            });
-            // Resize viewport to actual content width
-            await page.setViewport({
-                width: finalCssWidth,
-                height: cssHeight,
-                deviceScaleFactor: scaleFactor,
-            });
-        }
-
-        const pngBuffer = await page.screenshot({ type: "png" });
-
-        // Scale to target dimensions
-        // If tapeMm was used, scale from CSS dimensions to target 300 DPI dimensions
-        const scale = targetHeight / cssHeight;
-        const finalWidth = Math.round(finalCssWidth * scale);
-
-        if (scaleFactor > 1 || options.tapeMm) {
-            return scaleDown(Buffer.from(pngBuffer), finalWidth, targetHeight);
-        }
-        return Buffer.from(pngBuffer);
-    } finally {
-        await page.close();
-    }
-}
-
-/**
- * Render HTML file and save to PNG file
- */
-export async function renderHtmlToFile(
-    htmlPath: string,
-    outputPath: string,
-    options: RenderOptions
-): Promise<void> {
-    const buffer = await renderHtmlFile(htmlPath, options);
-    fs.writeFileSync(outputPath, buffer);
-}
-
-// Legacy export for compatibility
-export const renderHtml = renderHtmlFile;
+/**
+ * Backward-compat shim. The HTML rendering logic now lives in
+ * @bobfrankston/label-core. This file just re-exports those entry points so
+ * existing deep imports keep working.
+ */
+
+export {
+    renderHtmlString,
+    renderHtmlFile,
+    renderHtmlUrl,
+    closeBrowser,
+} from "@bobfrankston/label-core";
+export type { RenderOptions } from "@bobfrankston/label-core";
+
+import { renderHtmlFile as _renderHtmlFile } from "@bobfrankston/label-core";
+
+/** @deprecated Use renderHtmlFile from @bobfrankston/label-core. */
+export const renderHtml = _renderHtmlFile;
+
+/** @deprecated Render to a file by calling renderHtmlFile then fs.writeFileSync. */
+export async function renderHtmlToFile(
+    htmlPath: string,
+    outputPath: string,
+    options: { width?: number; height: number; tapeMm?: number; deviceScaleFactor?: number }
+): Promise<void> {
+    const fs = await import("fs");
+    const buffer = await _renderHtmlFile(htmlPath, options);
+    fs.writeFileSync(outputPath, buffer);
+}

package/tsconfig.json

@@ -1,19 +1,25 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "outDir": ".",
-    "rootDir": ".",
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "inlineSources": true
-  },
-  "include": ["*.ts"],
-  "exclude": ["node_modules"]
-}
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "inlineSources": true,
+    "strictNullChecks": false,
+    "noImplicitAny": true,
+    "noImplicitReturns": false,
+    "noImplicitThis": true,
+    "newLine": "lf",
+    "outDir": ".",
+    "rootDir": "."
+  },
+  "include": ["*.ts"],
+  "exclude": ["node_modules", "cruft", ".git", "tests", "prev"]
+}