boxpdf-html 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+import { RGB, Node } from 'boxpdf';
+import { PDFFont, PDFImage } from 'pdf-lib';
+
+interface HtmlToBoxpdfOptions {
+    font: PDFFont;
+    boldFont?: PDFFont;
+    italicFont?: PDFFont;
+    resolveFont?: HtmlFontResolver;
+    resolveImage?: HtmlImageResolver;
+    baseUrl?: string;
+    width?: number;
+    defaultFontSize?: number;
+    defaultLineHeight?: number;
+    defaultColor?: RGB;
+    profile?: HtmlProfileCallback;
+    diagnostics?: HtmlDiagnosticsOptions;
+}
+interface HtmlDiagnosticsOptions {
+    unsupportedCss?: boolean;
+    sampleLimit?: number;
+}
+interface HtmlProfileEvent {
+    phase: "start" | "parse-html" | "parse-css" | "compute-styles" | "render-tree" | "finish";
+    elapsedMs: number;
+    htmlBytes?: number;
+    domNodes?: number;
+    stylesheets?: number;
+    cssRules?: number;
+    styledNodes?: number;
+    boxNodes?: number;
+    paragraphs?: number;
+    textRuns?: number;
+}
+type HtmlProfileCallback = (event: HtmlProfileEvent) => void;
+type FontWeight = "normal" | "bold" | number;
+type FontStyle = "normal" | "italic";
+interface HtmlFontRequest {
+    families: string[];
+    weight: FontWeight;
+    style: FontStyle;
+}
+type HtmlFontResolver = (request: HtmlFontRequest) => PDFFont | undefined;
+type HtmlImageResolver = (request: HtmlImageRequest) => PDFImage | undefined;
+interface HtmlImageRequest {
+    url: string;
+    baseUrl?: string;
+}
+interface HtmlTextNode {
+    kind: "text";
+    value: string;
+    parent?: HtmlElementNode;
+}
+interface HtmlElementNode {
+    kind: "element";
+    tag: string;
+    attrs: Record<string, string>;
+    children: HtmlNode[];
+    parent?: HtmlElementNode;
+}
+type HtmlNode = HtmlTextNode | HtmlElementNode;
+interface ParsedHtml {
+    root: HtmlElementNode;
+    stylesheets: string[];
+}
+interface RenderResult {
+    nodes: Node[];
+    warnings: string[];
+    diagnostics?: HtmlDiagnostics;
+}
+interface HtmlDiagnostics {
+    unsupportedCss: HtmlUnsupportedCss[];
+}
+interface HtmlUnsupportedCss {
+    property: string;
+    value: string;
+    count: number;
+    samples?: string[];
+}
+
+type FontFamilyFace = PDFFont | Partial<Record<FontStyle | "bold" | "boldItalic" | `${number}`, PDFFont>>;
+type FontFamilyMap = Record<string, FontFamilyFace>;
+declare function fontFamily(families: FontFamilyMap): HtmlFontResolver;
+
+declare function parseHtml(html: string): ParsedHtml;
+
+declare function htmlToBoxpdf(html: string, options: HtmlToBoxpdfOptions): RenderResult;
+
+export { type FontFamilyFace, type FontFamilyMap, type FontStyle, type FontWeight, type HtmlDiagnostics, type HtmlDiagnosticsOptions, type HtmlFontRequest, type HtmlFontResolver, type HtmlProfileCallback, type HtmlProfileEvent, type HtmlToBoxpdfOptions, type HtmlUnsupportedCss, type ParsedHtml, type RenderResult, fontFamily, htmlToBoxpdf, parseHtml };

package/dist/index.js

@@ -0,0 +1,11 @@
+import {
+  fontFamily,
+  htmlToBoxpdf,
+  parseHtml
+} from "./chunk-23KN7BKZ.js";
+export {
+  fontFamily,
+  htmlToBoxpdf,
+  parseHtml
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "boxpdf-html",
+  "version": "1.0.0",
+  "description": "Readable HTML-to-PDF translator built on boxpdf.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "boxpdf-html": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "pdf",
+    "html",
+    "css",
+    "boxpdf",
+    "html-to-pdf"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "Erik Aronesty",
+    "email": "erik@q32.com"
+  },
+  "homepage": "https://github.com/earonesty/boxpdf-html#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/earonesty/boxpdf-html.git"
+  },
+  "bugs": {
+    "url": "https://github.com/earonesty/boxpdf-html/issues"
+  },
+  "dependencies": {
+    "boxpdf": "^1.7.0",
+    "css-tree": "^3.1.0",
+    "parse5": "^8.0.0",
+    "pdf-lib": "^1.17.1"
+  },
+  "devDependencies": {
+    "@tailwindcss/cli": "^4.3.0",
+    "@types/node": "^22.19.19",
+    "tailwindcss": "^4.3.0",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.6"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "packageManager": "pnpm@10.30.3"
+}