@stll/folio-core 0.61.0 → 0.63.0

package/dist/display-list/build/previewPrimitives.js

@@ -7,15 +7,13 @@ import { panic } from "better-result";
 * A drawing with no image data used to be given one: a megapixel PNG built the
 * moment something was about to paint it, which the DOM backend showed as an
 * `<img>` and the PDF exporter embedded as a bitmap — a photograph of a
-* drawing that is nothing but flat rectangles.
+* drawing that is vector geometry.
 *
-* The descriptor already holds those rectangles, in the drawing's own
-* coordinate space, and `rect` is a primitive both backends draw natively. So
-* the preview is drawn rather than sampled: the extent maps affinely onto the
-* image's box, every shape becomes a filled rectangle inside it, and no raster
-* exists at any point. The DOM backend paints each one as the absolutely
-* positioned div it paints every other `rect` as, and the PDF backend emits
-* `re`/`f` operators, so the drawing stays a drawing at any zoom.
+* The descriptor already holds rectangles, polygons, and polylines in the
+* drawing's own coordinate space, and each maps to native display-list
+* primitives. The preview is drawn rather than sampled: the extent maps
+* affinely onto the image's box, and no raster exists at any point, so the
+* drawing stays a drawing at any zoom.
 */
 /** The flat backdrop a preview is drawn on, behind every shape. */
 const PREVIEW_BACKGROUND = {
@@ -38,6 +36,7 @@ const clampFraction = (value) => Math.min(1, Math.max(0, value));
 * clip the raster did by clamping to its own bounds.
 */
 const shapeRect = ({ shape, extent, box }) => {
+	if (shape.type === "polygon" || shape.type === "polyline") return void 0;
 	const left = clampFraction(shape.x / extent.width);
 	const right = clampFraction((shape.x + shape.width) / extent.width);
 	const top = clampFraction(shape.y / extent.height);
@@ -56,6 +55,7 @@ const shapeRect = ({ shape, extent, box }) => {
 */
 const paintPreview = (descriptor, box) => {
 	switch (descriptor.kind) {
+		case "chart":
 		case "diagram": {
 			const primitives = [{
 				kind: "rect",
@@ -65,6 +65,35 @@ const paintPreview = (descriptor, box) => {
 			const { extent } = descriptor;
 			if (!(extent.width > 0 && extent.height > 0)) return primitives;
 			for (const shape of descriptor.shapes) {
+				const color = parseDisplayColor(shape.color) ?? PREVIEW_SHAPE_FILL;
+				if (shape.type === "polygon") {
+					primitives.push({
+						kind: "polygon",
+						points: shape.points.map(({ x, y }) => ({
+							xPx: box.xPx + clampFraction(x / extent.width) * box.widthPx,
+							yPx: box.yPx + clampFraction(y / extent.height) * box.heightPx
+						})),
+						fill: color
+					});
+					continue;
+				}
+				if (shape.type === "polyline") {
+					const points = shape.points.map(({ x, y }) => ({
+						xPx: box.xPx + clampFraction(x / extent.width) * box.widthPx,
+						yPx: box.yPx + clampFraction(y / extent.height) * box.heightPx
+					}));
+					const stroke = {
+						color,
+						thicknessPx: shape.strokeWidth * Math.min(box.widthPx / extent.width, box.heightPx / extent.height),
+						pattern: "solid"
+					};
+					primitives.push({
+						kind: "polyline",
+						points,
+						stroke
+					});
+					continue;
+				}
 				const rect = shapeRect({
 					shape,
 					extent,
@@ -74,7 +103,7 @@ const paintPreview = (descriptor, box) => {
 				primitives.push({
 					kind: "rect",
 					rect,
-					fill: parseDisplayColor(shape.color) ?? PREVIEW_SHAPE_FILL
+					fill: color
 				});
 			}
 			return primitives;

package/dist/display-list/build/regions.d.ts

@@ -1,12 +1,12 @@
 import { BlockId } from "../../layout-engine/types.js";
 import { DisplayHitRegion, DisplayHitRegionKind, DisplayHitRegionModel, DisplayPrimitive, DisplayRect, DisplayStoryRef } from "../types.js";
 //#region src/display-list/build/regions.d.ts
-type RegionDescriptor = {
+export type RegionDescriptor = {
   readonly kind: DisplayHitRegionKind;
   readonly rect: DisplayRect;
   readonly model?: DisplayHitRegionModel;
 };
-type PageComposer = {
+export type PageComposer = {
   /** Append primitives to the page, in paint order. */
   readonly push: (primitives: readonly DisplayPrimitive[]) => void;
   /**
@@ -17,7 +17,7 @@ type PageComposer = {
   readonly primitives: () => readonly DisplayPrimitive[];
   readonly regions: () => readonly DisplayHitRegion[];
 };
-declare const createPageComposer: () => PageComposer;
+export declare const createPageComposer: () => PageComposer;
 /**
  * The region a whole block occupies, wherever it is painted.
  *
@@ -41,6 +41,6 @@ type BlockRegionOptions = {
     readonly story: DisplayStoryRef;
   };
 };
-declare const blockRegion: ({ fragment, kind, context }: BlockRegionOptions) => RegionDescriptor;
+export declare const blockRegion: ({ fragment, kind, context }: BlockRegionOptions) => RegionDescriptor;
 //#endregion
-export { PageComposer, RegionDescriptor, blockRegion, createPageComposer };
+export {};

package/dist/display-list/build/storyPrimitives.d.ts

@@ -2,7 +2,7 @@ import { FlowBlock, Measure, Page } from "../../layout-engine/types.js";
 import { BuildContext } from "./buildContext.js";
 import { PageComposer } from "./regions.js";
 //#region src/display-list/build/storyPrimitives.d.ts
-type PaintStoryOptions = {
+export type PaintStoryOptions = {
   readonly composer: PageComposer;
   readonly blocks: readonly FlowBlock[];
   readonly measures: readonly Measure[];
@@ -20,13 +20,13 @@ type PaintHeaderFooterStoryOptions = PaintStoryOptions & {
  * A footnote body: every block stacks by its measured height, which is the
  * height the paginator reserved the band from.
  */
-declare const paintFootnoteBlocks: ({ composer, blocks, measures, xPx, yPx, widthPx, context, label }: PaintStoryOptions) => void;
+export declare const paintFootnoteBlocks: ({ composer, blocks, measures, xPx, yPx, widthPx, context, label }: PaintStoryOptions) => void;
 /**
  * A header or footer story. Blocks that Word takes out of the flow (a floating
  * table, an anchored image, a positioned text box) contribute no height, and
  * they are reported rather than painted: their position resolves against page
  * and margin anchors the display list producer does not carry.
  */
-declare const paintHeaderFooterBlocks: ({ composer, blocks, measures, xPx, yPx, widthPx, page, context, label }: PaintHeaderFooterStoryOptions) => void;
+export declare const paintHeaderFooterBlocks: ({ composer, blocks, measures, xPx, yPx, widthPx, page, context, label }: PaintHeaderFooterStoryOptions) => void;
 //#endregion
-export { PaintStoryOptions, paintFootnoteBlocks, paintHeaderFooterBlocks };
+export {};

package/dist/display-list/build/strokes.d.ts

@@ -16,7 +16,7 @@ type BorderInput = {
  * `threeDEmboss`/`threeDEngrave` as a plain line where the shading is
  * unavailable, so they stroke solid.
  */
-declare const CSS_BORDER_STROKE_PATTERNS: {
+export declare const CSS_BORDER_STROKE_PATTERNS: {
   readonly none: "none";
   readonly solid: "solid";
   readonly double: "double";
@@ -35,7 +35,7 @@ declare const CSS_BORDER_STROKE_PATTERNS: {
  * so the distinction collapses to dotted or dashed. It collapses here, once,
  * rather than at whichever consumer happened to know the spelling.
  */
-declare const PRESET_DASH_STROKE_PATTERNS: {
+export declare const PRESET_DASH_STROKE_PATTERNS: {
   readonly solid: "solid";
   readonly dot: "dotted";
   readonly dash: "dashed";
@@ -71,7 +71,7 @@ declare const PRESET_DASH_STROKE_PATTERNS: {
  * and its weight and stroke count are the plain ones by default rather than by
  * decision.
  */
-declare const UNDERLINE_STROKES: {
+export declare const UNDERLINE_STROKES: {
   readonly none: {
     readonly pattern: "none";
     readonly weight: 1;
@@ -163,7 +163,7 @@ declare const UNDERLINE_STROKES: {
     readonly strokes: 2;
   };
 };
-type ResolveStrokeResult = {
+export type ResolveStrokeResult = {
   readonly stroke?: DisplayStroke;
   /** The authored colour, when it could not be parsed. Report it, do not paint. */
   readonly unresolvedColor?: string;
@@ -173,16 +173,16 @@ type ResolveStrokeResult = {
  * "draw nothing": an explicit `none` style, a non-positive width, or a colour
  * this producer cannot resolve.
  */
-declare const resolveBorderStroke: (border: BorderInput) => ResolveStrokeResult;
+export declare const resolveBorderStroke: (border: BorderInput) => ResolveStrokeResult;
 type OutlineInput = {
   color?: string;
   dash?: PresetLineDashVal;
   width?: number;
 };
 /** Turn a shape or text-box outline into a paintable stroke. */
-declare const resolveOutlineStroke: (outline: OutlineInput) => ResolveStrokeResult;
-declare const underlinePattern: (style: UnderlineStyle | undefined) => StrokePattern;
-declare const underlineWeight: (style: UnderlineStyle | undefined) => number;
-declare const underlineStrokeCount: (style: UnderlineStyle | undefined) => number;
+export declare const resolveOutlineStroke: (outline: OutlineInput) => ResolveStrokeResult;
+export declare const underlinePattern: (style: UnderlineStyle | undefined) => StrokePattern;
+export declare const underlineWeight: (style: UnderlineStyle | undefined) => number;
+export declare const underlineStrokeCount: (style: UnderlineStyle | undefined) => number;
 //#endregion
-export { CSS_BORDER_STROKE_PATTERNS, PRESET_DASH_STROKE_PATTERNS, ResolveStrokeResult, UNDERLINE_STROKES, resolveBorderStroke, resolveOutlineStroke, underlinePattern, underlineStrokeCount, underlineWeight };
+export {};

package/dist/display-list/build/tablePrimitives.d.ts

@@ -9,7 +9,7 @@ type PaintTextBox = (options: {
   readonly measure: TextBoxMeasure;
   readonly context: BuildContext;
 }) => void;
-type TableBlockPaintOptions = {
+export type TableBlockPaintOptions = {
   readonly composer: PageComposer;
   readonly block: TableBlock;
   readonly measure: TableMeasure;
@@ -19,8 +19,8 @@ type TableBlockPaintOptions = {
   readonly paintTextBox: PaintTextBox;
 };
 /** A whole, unpaginated table: what a nested table inside a cell or box is. */
-declare const paintTableBlock: ({ composer, block, measure, xPx, yPx, context, paintTextBox }: TableBlockPaintOptions) => void;
-type TablePaintOptions = {
+export declare const paintTableBlock: ({ composer, block, measure, xPx, yPx, context, paintTextBox }: TableBlockPaintOptions) => void;
+export type TablePaintOptions = {
   readonly composer: PageComposer;
   readonly fragment: TableFragment;
   readonly block: TableBlock;
@@ -33,6 +33,6 @@ type TablePaintOptions = {
  * its rows in a `clipGroup` and starts them `topClip` px higher, which is what
  * the painter's negative row-stack offset plus `overflow: hidden` does.
  */
-declare const paintTableFragment: ({ composer, fragment, block, measure, context, paintTextBox }: TablePaintOptions) => void;
+export declare const paintTableFragment: ({ composer, fragment, block, measure, context, paintTextBox }: TablePaintOptions) => void;
 //#endregion
-export { TableBlockPaintOptions, TablePaintOptions, paintTableBlock, paintTableFragment };
+export {};

package/dist/display-list/build/tablePrimitives.js

@@ -4,6 +4,7 @@ import { tableFragmentBottomBorders } from "../../layout-engine/measure/tableFra
 import { resolveTableCellPadding } from "../../layout-engine/types.js";
 import { cellTextRotationDegrees } from "../../layout-painter/renderTable.js";
 import { paintsCssBorder } from "../../utils/borderCss.js";
+import { intersectHorizontalClipViewports } from "../../utils/paragraphInlineLayout.js";
 import { HIT_REGION_KINDS } from "../primitives.js";
 import { parseDisplayColor } from "./colors.js";
 import { paintImageFragment } from "./imagePrimitives.js";
@@ -99,6 +100,13 @@ const paintCell = ({ composer, cell, cellMeasure, box, context, paintTextBox, si
 	const contentXPx = box.xPx + widths.left + padding.left;
 	const contentYPx = box.yPx + widths.top + padding.top;
 	const contentWidthPx = Math.max(0, cellMeasure.width - padding.left - padding.right);
+	const cellPictureViewport = intersectHorizontalClipViewports(context.inlinePictureViewport, cell.textDirection === "btLr" ? {
+		left: contentXPx,
+		right: contentXPx + contentWidthPx
+	} : {
+		left: box.xPx,
+		right: box.xPx + box.widthPx
+	});
 	if (cellTextRotationDegrees(cell.textDirection) !== 0) context.unsupported.report(UNSUPPORTED_CONSTRUCT.verticalCellText, context.pageIndex, `w:textDirection ${cell.textDirection} paints horizontally`);
 	composer.push(primitives);
 	primitives.length = 0;
@@ -109,6 +117,7 @@ const paintCell = ({ composer, cell, cellMeasure, box, context, paintTextBox, si
 		xPx: contentXPx,
 		yPx: contentYPx,
 		widthPx: contentWidthPx,
+		inlinePictureViewport: cellPictureViewport,
 		context,
 		paintTextBox
 	});
@@ -137,7 +146,7 @@ const paintCell = ({ composer, cell, cellMeasure, box, context, paintTextBox, si
 * A cell's inner blocks, stacked by the same flow state the measurer used, so
 * paragraph spacing collapses in paint exactly where it collapsed in layout.
 */
-const paintCellBlocks = ({ composer, blocks, measures, xPx, yPx, widthPx, context, paintTextBox }) => {
+const paintCellBlocks = ({ composer, blocks, measures, xPx, yPx, widthPx, inlinePictureViewport, context, paintTextBox }) => {
 	const flowState = createTableCellFlowState();
 	for (let index = 0; index < blocks.length; index += 1) {
 		const block = blocks[index];
@@ -171,6 +180,7 @@ const paintCellBlocks = ({ composer, blocks, measures, xPx, yPx, widthPx, contex
 					block,
 					measure,
 					context,
+					inlinePictureViewport,
 					...previous?.kind === "paragraph" && previous.attrs?.borders !== void 0 ? { prevBorders: previous.attrs.borders } : {},
 					...next?.kind === "paragraph" && next.attrs?.borders !== void 0 ? { nextBorders: next.attrs.borders } : {}
 				});
@@ -196,7 +206,10 @@ const paintCellBlocks = ({ composer, blocks, measures, xPx, yPx, widthPx, contex
 					measure,
 					xPx: fragment.x,
 					yPx: fragment.y,
-					context,
+					context: {
+						...context,
+						inlinePictureViewport
+					},
 					paintTextBox
 				});
 			});

package/dist/display-list/build/textBoxPrimitives.d.ts

@@ -2,13 +2,12 @@ import { TextBoxBlock, TextBoxFragment, TextBoxMeasure } from "../../layout-engi
 import { BuildContext } from "./buildContext.js";
 import { PageComposer } from "./regions.js";
 //#region src/display-list/build/textBoxPrimitives.d.ts
-type TextBoxPaintOptions = {
+export type TextBoxPaintOptions = {
   readonly composer: PageComposer;
   readonly fragment: TextBoxFragment;
   readonly block: TextBoxBlock;
   readonly measure: TextBoxMeasure;
   readonly context: BuildContext;
 };
-declare const paintTextBoxFragment: ({ composer, fragment, block, measure, context }: TextBoxPaintOptions) => void;
-//#endregion
-export { TextBoxPaintOptions, paintTextBoxFragment };
+export declare const paintTextBoxFragment: ({ composer, fragment, block, measure, context }: TextBoxPaintOptions) => void;
+//#endregion

package/dist/display-list/build/textBoxPrimitives.js

@@ -125,6 +125,10 @@ const paintUnrotatedTextBoxFragment = ({ composer, fragment, block, measure, con
 					block: contentBlock,
 					measure: contentMeasure,
 					context,
+					inlinePictureViewport: {
+						left: contentFragment.x,
+						right: contentFragment.x + contentFragment.width
+					},
 					...previous?.kind === "paragraph" && previous.attrs?.borders !== void 0 ? { prevBorders: previous.attrs.borders } : {},
 					...next?.kind === "paragraph" && next.attrs?.borders !== void 0 ? { nextBorders: next.attrs.borders } : {}
 				});

package/dist/display-list/build/textDecorations.d.ts

@@ -16,10 +16,10 @@
  * it. Every constant is in one place so that follow-up is a single edit.
  */
 /** Distance below the baseline to the centre of the underline, as a fraction of the em. */
-declare const UNDERLINE_OFFSET_RATIO = 0.1;
+export declare const UNDERLINE_OFFSET_RATIO = 0.1;
 /** Underline thickness as a fraction of the em, floored so a hairline stays visible. */
-declare const UNDERLINE_THICKNESS_RATIO: number;
-declare const MIN_DECORATION_THICKNESS_PX = 1;
+export declare const UNDERLINE_THICKNESS_RATIO: number;
+export declare const MIN_DECORATION_THICKNESS_PX = 1;
 /**
  * What an underline member's thickness is a multiple of the plain one.
  *
@@ -32,12 +32,11 @@ declare const MIN_DECORATION_THICKNESS_PX = 1;
  * (`formatToStyle.ts:underlineDecorationCss`). Two copies would let the page
  * and the editor draw the same member at two weights.
  */
-declare const PLAIN_UNDERLINE_WEIGHT = 1;
-declare const HEAVY_UNDERLINE_WEIGHT = 2;
+export declare const PLAIN_UNDERLINE_WEIGHT = 1;
+export declare const HEAVY_UNDERLINE_WEIGHT = 2;
 /** Distance above the baseline to the centre of the strikethrough, as a fraction of the em. */
-declare const STRIKETHROUGH_OFFSET_RATIO = 0.28;
-declare const underlineThicknessPx: (fontSizePx: number) => number;
-declare const underlineCenterYPx: (baselineYPx: number, fontSizePx: number) => number;
-declare const strikethroughCenterYPx: (baselineYPx: number, fontSizePx: number) => number;
-//#endregion
-export { HEAVY_UNDERLINE_WEIGHT, MIN_DECORATION_THICKNESS_PX, PLAIN_UNDERLINE_WEIGHT, STRIKETHROUGH_OFFSET_RATIO, UNDERLINE_OFFSET_RATIO, UNDERLINE_THICKNESS_RATIO, strikethroughCenterYPx, underlineCenterYPx, underlineThicknessPx };
+export declare const STRIKETHROUGH_OFFSET_RATIO = 0.28;
+export declare const underlineThicknessPx: (fontSizePx: number) => number;
+export declare const underlineCenterYPx: (baselineYPx: number, fontSizePx: number) => number;
+export declare const strikethroughCenterYPx: (baselineYPx: number, fontSizePx: number) => number;
+//#endregion

package/dist/display-list/build/unsupported.d.ts

@@ -4,7 +4,7 @@ import { DisplayUnsupported } from "../types.js";
  * Every construct name the builder can report. Named rather than free-form so
  * a consumer can switch over them, and so a typo cannot invent a new category.
  */
-declare const UNSUPPORTED_CONSTRUCT: {
+export declare const UNSUPPORTED_CONSTRUCT: {
   /** `w:effect` animations (blinkBackground, shimmer, …). */
   readonly textEffect: "textEffect";
   /** `w:w` horizontal scale: folded into advances, but the glyphs are not narrowed. */
@@ -46,12 +46,11 @@ declare const UNSUPPORTED_CONSTRUCT: {
   /** A block/measure pair whose kinds disagree. */
   readonly measureMismatch: "measureMismatch";
 };
-type UnsupportedConstruct = (typeof UNSUPPORTED_CONSTRUCT)[keyof typeof UNSUPPORTED_CONSTRUCT];
-declare class UnsupportedCollector {
+export type UnsupportedConstruct = (typeof UNSUPPORTED_CONSTRUCT)[keyof typeof UNSUPPORTED_CONSTRUCT];
+export declare class UnsupportedCollector {
   private readonly entries;
   private readonly seen;
   report(construct: UnsupportedConstruct, pageIndex: number, detail: string): void;
   snapshot(): readonly DisplayUnsupported[];
 }
-//#endregion
-export { UNSUPPORTED_CONSTRUCT, UnsupportedCollector, UnsupportedConstruct };
+//#endregion

package/dist/display-list/build/watermarkPrimitives.d.ts

@@ -1,16 +1,17 @@
 import { document_d_exports } from "../../types/document.js";
+import { DocumentFontFacts } from "../../fonts/documentFontFacts.js";
 import { Page } from "../../layout-engine/types.js";
 import { DisplayPrimitive } from "../types.js";
 import { BuildContext } from "./buildContext.js";
 //#region src/display-list/build/watermarkPrimitives.d.ts
-type WatermarkPaintOptions = {
+export type WatermarkPaintOptions = {
   embeddedFontFamilyMap?: ReadonlyMap<string, string> | undefined;
+  documentFontFacts?: DocumentFontFacts | undefined;
   readonly page: Page;
   readonly watermark: document_d_exports.Watermark;
   /** Resolved `data:` source for a picture watermark; absent means unresolved. */
   readonly imageSrc?: string;
   readonly context: BuildContext;
 };
-declare const paintWatermark: ({ page, watermark, imageSrc, context, embeddedFontFamilyMap }: WatermarkPaintOptions) => readonly DisplayPrimitive[];
-//#endregion
-export { WatermarkPaintOptions, paintWatermark };
+export declare const paintWatermark: ({ page, watermark, imageSrc, context, embeddedFontFamilyMap, documentFontFacts }: WatermarkPaintOptions) => readonly DisplayPrimitive[];
+//#endregion

package/dist/display-list/build/watermarkPrimitives.js

@@ -5,20 +5,6 @@ import { buildGlyphs, glyphRunText } from "./glyphs.js";
 import { UNSUPPORTED_CONSTRUCT } from "./unsupported.js";
 //#region src/display-list/build/watermarkPrimitives.ts
 /**
-* The document watermark, behind the page's content.
-*
-* Word stores it as a VML shape in a header part; the painter reproduces it
-* with CSS rather than mirroring `v:textpath`, and this reproduces the same
-* result as primitives: a text watermark is one rotated, translucent run
-* centred on the page; a picture watermark is the image scaled to fit a
-* fraction of the page and washed out.
-*
-* A picture watermark needs its bytes. The relationship id → asset mapping
-* belongs to the package layer, so a caller that cannot resolve it hands over
-* no source and the watermark is reported rather than dropped: a page missing
-* its watermark and a page that never had one must not look alike.
-*/
-/**
 * `renderWatermark.ts`: Word's text-watermark preset is ~144px bold silver at
 * half opacity, rotated bottom-left to top-right.
 */
@@ -29,10 +15,11 @@ const TEXT_DEFAULT_OPACITY = .5;
 const TEXT_DIAGONAL_DEGREES = -45;
 const PICTURE_NATIVE_SCALE = 1;
 const PICTURE_WASHOUT_OPACITY = .18;
-const paintTextWatermark = ({ watermark, page, context, embeddedFontFamilyMap }) => {
+const paintTextWatermark = ({ watermark, page, context, embeddedFontFamilyMap, documentFontFacts }) => {
 	if (watermark.text.length === 0) return [];
 	const style = {
 		...embeddedFontFamilyMap ? { embeddedFontFamilyMap } : {},
+		...documentFontFacts ? { documentFontFacts } : {},
 		fontFamily: watermark.font ?? TEXT_DEFAULT_FONT,
 		fontSize: pxToPt(TEXT_FONT_SIZE_PX),
 		bold: true
@@ -130,13 +117,14 @@ const paintPictureWatermark = (watermark, page, imageSrc, context) => {
 		opacity: watermark.washout === false ? 1 : PICTURE_WASHOUT_OPACITY
 	}];
 };
-const paintWatermark = ({ page, watermark, imageSrc, context, embeddedFontFamilyMap }) => {
+const paintWatermark = ({ page, watermark, imageSrc, context, embeddedFontFamilyMap, documentFontFacts }) => {
 	switch (watermark.kind) {
 		case "text": return paintTextWatermark({
 			watermark,
 			page,
 			context,
-			embeddedFontFamilyMap
+			embeddedFontFamilyMap,
+			documentFontFacts
 		});
 		case "picture": return paintPictureWatermark(watermark, page, imageSrc, context);
 		default: return [];

package/dist/display-list/dom/renderDisplayListToDom.d.ts

@@ -6,8 +6,8 @@ import { DisplayColor, DisplayFontFace, DisplayImageSource, DisplayList, Display
  * `dataUrl` always inlines the bytes (markup that leaves the process, such as
  * a serialized page, where a `blob:` URL would resolve to nothing).
  */
-type DisplayBinaryUrls = "objectUrl" | "dataUrl";
-type RenderDisplayListOptions = {
+export type DisplayBinaryUrls = "objectUrl" | "dataUrl";
+export type RenderDisplayListOptions = {
   /** Document to create elements in. */
   readonly doc: Document;
   /** Page background, painted before any primitive. */
@@ -20,7 +20,7 @@ type RenderDisplayListOptions = {
  * internal link addresses a page by its index in the same list, so rendering
  * one page needs all three passed alongside it.
  */
-type RenderDisplayPageOptions = RenderDisplayListOptions & {
+export type RenderDisplayPageOptions = RenderDisplayListOptions & {
   /** `DisplayList.fonts`. */
   readonly fonts: readonly DisplayFontFace[];
   /** `DisplayList.images`. */
@@ -28,8 +28,8 @@ type RenderDisplayPageOptions = RenderDisplayListOptions & {
   /** The page's index in `DisplayList.pages`, which names its anchor. */
   readonly pageIndex: number;
 };
-declare const renderDisplayPageToDom: (page: DisplayPage, options: RenderDisplayPageOptions) => HTMLElement;
-/** One `div.layout-page` per display page, in page order. */
-declare const renderDisplayListToDom: (list: DisplayList, options: RenderDisplayListOptions) => HTMLElement[];
-//#endregion
-export { DisplayBinaryUrls, RenderDisplayListOptions, RenderDisplayPageOptions, renderDisplayListToDom, renderDisplayPageToDom };
+/** Render one page; release its resources before discarding the element. */
+export declare const renderDisplayPageToDom: (page: DisplayPage, options: RenderDisplayPageOptions) => HTMLElement;
+/** One `div.layout-page` per display page, in page order. Release each page's resources before discarding it. */
+export declare const renderDisplayListToDom: (list: DisplayList, options: RenderDisplayListOptions) => HTMLElement[];
+//#endregion