postext-pdf 0.1.0

package/dist/pdf-backend/renderResourceBlock.d.ts

@@ -0,0 +1,87 @@
+/**
+ * PDF rendering of resource blocks (issue #49 §7).
+ *
+ * Draws an embedded `Resource` (bitmap / svg / table) plus its caption into a
+ * pdf-lib page. Image payloads live out-of-band (IndexedDB in the sandbox); the
+ * host supplies their raw bytes via {@link RenderToPdfOptions.resourceBytes},
+ * which {@link preloadResourceImages} embeds into the document up front (PDF
+ * embedding is async; page rendering is sync).
+ *
+ * The bytes are sniffed, so the host never has to say what it hands over:
+ *   - `%PDF`  → the first page is embedded as a form XObject and drawn
+ *               verbatim (vector print masters, `Resource.svg.pdfFileId`);
+ *   - SVG     → single-ink recolouring when `diagramStyle.singleInk` is on,
+ *               then vector emission through {@link svgToVectorDrawing}, with
+ *               `text` set in fonts loaded through the document's
+ *               {@link FontCache} (same provider as the body text); SVGs
+ *               outside the supported subset are rasterised (browser only) at
+ *               {@link RASTER_DPI} for their largest placement;
+ *   - PNG / JPEG / WebP / GIF → `embedPng` / `embedJpg` (WebP is decoded to
+ *               PNG via a canvas first; browser only).
+ * A missing or undecodable payload leaves the map entry absent and the
+ * renderer draws a neutral placeholder.
+ *
+ * Inline `:ref` segments render in the link colour and, via {@link LinkRegistry},
+ * become clickable link annotations targeting the resource embed's destination.
+ */
+import { type PDFImage, type PDFDocument, type PDFEmbeddedPage } from 'pdf-lib';
+import type { VDTBlock, VDTDocument } from 'postext';
+import { FontCache, type PdfFontProvider } from '../fontCache';
+import { type PageCtx } from './primitives';
+import { LinkRegistry } from './links';
+import type { StructureFlow } from './structureFlow';
+import { type VectorDrawing } from './svgVector';
+/** Raw bytes of a resource binary, keyed by `fileId`. */
+export type ResourceBytesProvider = (fileId: string) => Uint8Array | undefined;
+/** One embedded resource payload, ready to draw on any page. */
+export type EmbeddedResource = {
+    kind: 'image';
+    image: PDFImage;
+} | {
+    kind: 'page';
+    page: PDFEmbeddedPage;
+} | {
+    kind: 'vector';
+    drawing: VectorDrawing;
+};
+/** Embedded resources keyed by `fileId`, shared across pages. */
+export type ResourceImageMap = Map<string, EmbeddedResource>;
+/** Resolution of the raster fallback for SVGs the vector path cannot emit,
+ *  relative to the figure's largest placement on the page. Diagrams are line
+ *  art with small type, so this sits above the 300 dpi photographs need. */
+export declare const RASTER_DPI = 600;
+type Sniffed = 'pdf' | 'svg' | 'png' | 'jpeg' | 'webp' | 'gif' | 'unknown';
+/** Identify a payload from its leading bytes. */
+export declare function sniffBytes(bytes: Uint8Array): Sniffed;
+/** Rasterises SVG markup to PNG bytes at a pixel size; null when it cannot. */
+export type SvgRasterizer = (svgText: string, widthPx: number, heightPx: number) => Promise<Uint8Array | null>;
+/** Rasterise SVG markup to PNG bytes at the given pixel size, through an
+ *  `Image` and a canvas of the document. Browser main thread only (a
+ *  worker cannot decode SVG); returns null elsewhere or when the SVG does
+ *  not decode. The default {@link SvgRasterizer}. */
+export declare function rasterizeSvgWithDom(svgText: string, widthPx: number, heightPx: number): Promise<Uint8Array | null>;
+/** Before an SVG with text is rasterised through an `<img>` — which cannot
+ *  see any page font — embed the faces its runs ask for as `@font-face` data
+ *  URIs, fetched from the same provider the body text uses. Families the
+ *  provider cannot supply are skipped (the image falls back to a system
+ *  face, as the screen preview would). */
+export declare function inlineSvgFontsForRaster(svgText: string, fontStrings: string[], provider: PdfFontProvider): Promise<string>;
+/**
+ * Embed every bitmap / svg / print-master resource referenced in the
+ * document. Returns a map of `fileId → EmbeddedResource` consumed by
+ * {@link renderResourceBlock} and the design-overlay image blocks. A missing or
+ * undecodable payload is simply absent from the map and the renderer draws a
+ * placeholder.
+ */
+export declare function preloadResourceImages(pdfDoc: PDFDocument, doc: VDTDocument, bytesProvider: ResourceBytesProvider | undefined, fontCache?: FontCache, fontProvider?: PdfFontProvider, 
+/** Map to add to (a book renders several documents into one PDF; a
+ *  resource is embedded once for all of them). */
+into?: ResourceImageMap, 
+/** How to rasterise an SVG outside the vector subset; the document's
+ *  own `Image` by default (a worker hands the job to its host). */
+rasterizeSvg?: SvgRasterizer): Promise<ResourceImageMap>;
+/** Draw an embedded resource fitted to a box in document pixels (top-down). */
+export declare function drawEmbeddedResource(ctx: PageCtx, res: EmbeddedResource, xPx: number, yPx: number, wPx: number, hPx: number): void;
+export declare function renderResourceBlock(ctx: PageCtx, block: VDTBlock, fontCache: FontCache, images: ResourceImageMap, linkRegistry: LinkRegistry | undefined, structure?: StructureFlow): void;
+export {};
+//# sourceMappingURL=renderResourceBlock.d.ts.map

package/dist/pdf-backend/renderResourceBlock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderResourceBlock.d.ts","sourceRoot":"","sources":["../../src/pdf-backend/renderResourceBlock.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,EAA4B,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAgB,MAAM,SAAS,CAAC;AACxH,OAAO,KAAK,EACV,QAAQ,EAER,WAAW,EAGZ,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EACL,KAAK,OAAO,EAUb,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAGL,KAAK,aAAa,EAGnB,MAAM,aAAa,CAAC;AAErB,yDAAyD;AACzD,MAAM,MAAM,qBAAqB,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,UAAU,GAAG,SAAS,CAAC;AAE/E,gEAAgE;AAChE,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GACvC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,aAAa,CAAA;CAAE,CAAC;AAE/C,iEAAiE;AACjE,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAE7D;;4EAE4E;AAC5E,eAAO,MAAM,UAAU,MAAM,CAAC;AAE9B,KAAK,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;AAE3E,iDAAiD;AACjD,wBAAgB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAkBrD;AAoCD,+EAA+E;AAC/E,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;AAE/G;;;qDAGqD;AACrD,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAyBxH;AAkED;;;;0CAI0C;AAC1C,wBAAsB,uBAAuB,CAC3C,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EAAE,EACrB,QAAQ,EAAE,eAAe,GACxB,OAAO,CAAC,MAAM,CAAC,CAejB;AAiCD;;;;;;GAMG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,WAAW,EACnB,GAAG,EAAE,WAAW,EAChB,aAAa,EAAE,qBAAqB,GAAG,SAAS,EAChD,SAAS,CAAC,EAAE,SAAS,EACrB,YAAY,CAAC,EAAE,eAAe;AAC9B;kDACkD;AAClD,IAAI,CAAC,EAAE,gBAAgB;AACvB;mEACmE;AACnE,YAAY,GAAE,aAAmC,GAChD,OAAO,CAAC,gBAAgB,CAAC,CAyG3B;AAED,+EAA+E;AAC/E,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,OAAO,EACZ,GAAG,EAAE,gBAAgB,EACrB,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,GACV,IAAI,CAWN;AAyPD,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,QAAQ,EACf,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,gBAAgB,EACxB,YAAY,EAAE,YAAY,GAAG,SAAS,EACtC,SAAS,CAAC,EAAE,aAAa,GACxB,IAAI,CA8GN"}