renderpdf-js 0.2.0 → 0.3.0

package/dist/jspdf-adapter.d.ts

@@ -0,0 +1,159 @@
+import { type PDFBuilder } from './document.js';
+import type { DocumentImageSource, DocumentPageOptions, PDFDocumentOptions } from './document-types.js';
+import type { RenderPDFResult } from './api-types.js';
+/** Prepared font descriptor consumed by DevExtreme's synchronous PDF exporter. */
+export interface JsPDFAdapterFont {
+    readonly fontName: string;
+    readonly fontStyle: 'normal' | 'bold' | 'italic' | 'bolditalic';
+    readonly fontWeight: number;
+}
+/** Supported text placement; complex scripts and advanced jsPDF transforms are outside this adapter. */
+export interface JsPDFAdapterTextOptions {
+    align?: 'left' | 'center' | 'right';
+    baseline?: 'alphabetic' | 'top' | 'middle' | 'bottom' | 'hanging' | 'ideographic';
+    angle?: number;
+    /** jsPDF uses counterclockwise angles by default; zero selects clockwise rotation. */
+    rotationDirection?: 0 | 1;
+    lineHeightFactor?: number;
+    maxWidth?: number;
+    isInputVisual?: boolean;
+    isOutputVisual?: boolean;
+    isInputRtl?: boolean;
+    isOutputRtl?: boolean;
+}
+/** Explicit font overrides used by the exporter's text measurement calls. */
+export interface JsPDFAdapterMeasureOptions {
+    font?: JsPDFAdapterFont;
+    fontName?: string;
+    fontStyle?: string;
+    fontSize?: number;
+    maxWidth?: number;
+}
+type ColorChannel = number | string;
+/** Narrow color-normalization contract used by DevExtreme 25.1. */
+export interface JsPDFAdapterColorOptions {
+    ch1: ColorChannel;
+    ch2?: ColorChannel;
+    ch3?: ColorChannel;
+    ch4?: ColorChannel;
+    precision?: number;
+    pdfColorType?: string;
+}
+/** Parse a PDF color token, or an already canonical CSS color, into RGB hex. */
+declare function decodeColor(token: string): string;
+/** Normalize supported jsPDF grayscale, RGB and CMYK channels without vendor code. */
+declare function encodeColor(options: JsPDFAdapterColorOptions | string): string;
+/** A prepared, scoped facade for DevExtreme 25.1; serialization is explicitly asynchronous. */
+export declare class JsPDFAdapter {
+    private readonly document;
+    /** jsPDF-compatible units and current page dimensions used by DevExtreme. */
+    readonly internal: {
+        readonly scaleFactor: number;
+        readonly pageSize: {
+            getWidth(): number;
+            getHeight(): number;
+        };
+        getNumberOfPages(): number;
+    };
+    /** DevExtreme's bounded private color bridge; unrelated jsPDF internals are unsupported. */
+    readonly __private__: Readonly<{
+        encodeColorString: typeof encodeColor;
+        decodeColorString: typeof decodeColor;
+    }>;
+    private currentPage;
+    private state;
+    private readonly commands;
+    private readonly savedStates;
+    private readonly activePaths;
+    private completion?;
+    /** Construct through createJsPDFAdapter so fonts exist before synchronous export begins. */
+    constructor(document: PDFBuilder);
+    /** Reject drawing after serialization starts, preserving a deterministic snapshot. */
+    private assertMutable;
+    /** Record paint in order so asynchronous image embedding cannot move it above later text. */
+    private enqueue;
+    /** Select a prepared face and validate it through the core's synchronous metrics. */
+    getFont(name?: string | null, style?: string | null): JsPDFAdapterFont;
+    /** Select a preloaded face; load custom bytes in the factory's fonts option. */
+    setFont(name: string, style?: string, weight?: number): this;
+    /** Set typographic points independently of the document's coordinate unit. */
+    setFontSize(size: number): this;
+    /** Return the current point size. */
+    getFontSize(): number;
+    /** Set the baseline-to-baseline font-size multiplier. */
+    setLineHeightFactor(value: number): this;
+    /** Return the current baseline spacing multiplier. */
+    getLineHeightFactor(): number;
+    /** Set border width in document coordinates. */
+    setLineWidth(width: number): this;
+    /** Return border width in document coordinates. */
+    getLineWidth(): number;
+    /** Normalize a color to the same representation returned by the private bridge. */
+    private color;
+    /** Set text color from gray, RGB, CMYK or a supported CSS color. */
+    setTextColor(ch1: ColorChannel, ch2?: ColorChannel, ch3?: ColorChannel, ch4?: ColorChannel): this;
+    /** Return normalized text color. */
+    getTextColor(): string;
+    /** Set stroke color. */
+    setDrawColor(ch1: ColorChannel, ch2?: ColorChannel, ch3?: ColorChannel, ch4?: ColorChannel): this;
+    /** Return normalized stroke color. */
+    getDrawColor(): string;
+    /** Set fill color. */
+    setFillColor(ch1: ColorChannel, ch2?: ColorChannel, ch3?: ColorChannel, ch4?: ColorChannel): this;
+    /** Return normalized fill color. */
+    getFillColor(): string;
+    /** Measure width and jsPDF-style line height synchronously in document units. */
+    getTextDimensions(text: string | number | readonly string[], options?: JsPDFAdapterMeasureOptions): {
+        w: number;
+        h: number;
+    };
+    /** Return the current face's text width. */
+    getTextWidth(text: string): number;
+    /** Wrap by measured words, splitting oversized words without losing characters. */
+    splitTextToSize(text: string | number | readonly string[], width: number, options?: JsPDFAdapterMeasureOptions): string[];
+    /** Position text using the supported alignment and baseline options. */
+    text(text: string | readonly string[], x: number, y: number, options?: JsPDFAdapterTextOptions): this;
+    /** Paint one stroke with the current line state. */
+    line(x1: number, y1: number, x2: number, y2: number): this;
+    /** Paint a rectangle; path-only styles are outside the exporter contract. */
+    rect(x: number, y: number, width: number, height: number, style?: string): this;
+    /** Preserve both PDF graphics and adapter style state. */
+    saveGraphicsState(): this;
+    /** Restore a state saved on this same page. */
+    restoreGraphicsState(): this;
+    /** Begin a clipping path in document coordinates. */
+    moveTo(x: number, y: number): this;
+    /** Append one path segment. */
+    lineTo(x: number, y: number): this;
+    /** Close the current path; this is not a document-disposal operation. */
+    close(): this;
+    /** Apply the current path as a clip. */
+    clip(): this;
+    /** Clear the current path after clipping. */
+    discardPath(): this;
+    /** Add a page using jsPDF's array format and optional orientation shorthand. */
+    addPage(format?: DocumentPageOptions['format'] | readonly [number, number], orientation?: 'p' | 'l' | 'portrait' | 'landscape'): this;
+    /** Select an existing one-based page for later footer and title paint. */
+    setPage(pageNumber: number): this;
+    /** Return the total number of pages already added. */
+    getNumberOfPages(): number;
+    /** Queue image placement without allowing asynchronous embedding to reorder paint. */
+    addImage(source: DocumentImageSource, format: string, x: number, y: number, width: number, height: number): this;
+    /** Flush ordered drawing once and return the immutable common PDF result. */
+    toResult(): Promise<RenderPDFResult>;
+    /** Return an asynchronously finalized PDF Blob. */
+    toBlob(): Promise<Blob>;
+    /** Return independent PDF bytes. */
+    toUint8Array(): Promise<Uint8Array>;
+    /** Save asynchronously; callers must await this method. */
+    save(filename?: string): Promise<void>;
+    /** Download alias matching the library's result API. */
+    download(filename?: string): Promise<void>;
+    /** Unlike jsPDF, every output form returns a Promise and must be awaited. */
+    output(type: 'blob'): Promise<Blob>;
+    output(type: 'arraybuffer'): Promise<ArrayBuffer>;
+    output(type: 'uint8array'): Promise<Uint8Array>;
+}
+/** Prepare fonts and millimeter coordinates before passing the facade as jsPDFDocument. */
+export declare function createJsPDFAdapter(options?: PDFDocumentOptions): Promise<JsPDFAdapter>;
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "renderpdf-js",
-  "version": "0.2.0",
-  "description": "Browser-side HTML and image to PDF renderer with explicit fonts, local rasters and multipage TIFF",
+  "version": "0.3.0",
+  "description": "Create PDFs from HTML, images or code, and merge or split existing PDFs.",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -18,7 +18,10 @@
     "typescript",
     "html-to-pdf",
     "image-to-pdf",
-    "tiff-to-pdf"
+    "tiff-to-pdf",
+    "pdf-generation",
+    "pdf-merge",
+    "pdf-split"
   ],
   "publishConfig": {
     "access": "public",
@@ -37,6 +40,7 @@
     "dist/index.js",
     "dist/*.d.ts",
     "README.md",
+    "API.md",
     "LICENSE",
     "assets/renderpdf-logo.png"
   ],
@@ -52,6 +56,7 @@
     "typecheck": "vp check --no-fmt --no-lint",
     "test": "vp test",
     "test:browser": "playwright test",
+    "test:devextreme": "playwright test --config playwright.devextreme.config.ts",
     "benchmark": "npm run build:library && playwright test --config playwright.benchmark.config.ts",
     "lint": "vp lint",
     "format": "vp fmt",