@stll/folio-core 0.32.2 → 0.33.1

package/dist/managers/editorShortcuts.js

@@ -32,6 +32,25 @@ function classifyEditorKeydown(e, { isMac, isInputLike }) {
 	}
 	return { type: "none" };
 }
+/** `contains` rejects a non-node argument, so screen the target first. */
+function isNode(target) {
+	return typeof target === "object" && target !== null && "nodeType" in target;
+}
+/**
+* Whether a keydown is one the editor answers under `scope`. The adapters own
+* the listener; this decides, from the event target alone, whether the press
+* belongs to this editor or to whatever else the host has on the page.
+*/
+function isKeydownInShortcutScope(event, { scope, roots }) {
+	switch (scope) {
+		case "document": return true;
+		case "none": return false;
+		case "editor":
+			if (!isNode(event.target)) return false;
+			return roots.some((root) => root?.contains(event.target) === true);
+		default: return scope;
+	}
+}
 /**
 * If the selection is a ProseMirror `CellSelection` covering every cell of its
 * table, delete the table and return `true`. Returns `false` for any other
@@ -57,4 +76,4 @@ function deleteSelectedTable(state, dispatch) {
 	return false;
 }
 //#endregion
-export { classifyEditorKeydown, deleteSelectedTable, isFocusInInputLike, isMacPlatform };
+export { classifyEditorKeydown, deleteSelectedTable, isFocusInInputLike, isKeydownInShortcutScope, isMacPlatform };

package/dist/markdown/renderRuns.js

@@ -145,11 +145,16 @@ function renderHyperlink(ctx, pkg, link, paraId) {
 	return `[${inner}](${escapeLinkUrl(href)})`;
 }
 function renderTrackedWrapper(ctx, pkg, wrapper, paraId) {
+	const renderChild = (child) => {
+		if (child.type === "run") return renderRun(ctx, pkg, child, paraId);
+		if (child.type === "hyperlink") return renderHyperlink(ctx, pkg, child, paraId);
+		return "";
+	};
 	if (ctx.opts.trackedChanges === "clean") {
-		if (wrapper.type === "insertion" || wrapper.type === "moveTo") return wrapper.content.map((child) => child.type === "run" ? renderRun(ctx, pkg, child, paraId) : renderHyperlink(ctx, pkg, child, paraId)).join("");
+		if (wrapper.type === "insertion" || wrapper.type === "moveTo") return wrapper.content.map(renderChild).join("");
 		return "";
 	}
-	const inner = wrapper.content.map((child) => child.type === "run" ? renderRun(ctx, pkg, child, paraId) : renderHyperlink(ctx, pkg, child, paraId)).join("");
+	const inner = wrapper.content.map(renderChild).join("");
 	switch (wrapper.type) {
 		case "insertion": return wrapInsertion(ctx, wrapper.info, inner);
 		case "deletion": return wrapDeletion(ctx, wrapper.info, inner);

package/dist/markdown/renderTable.js

@@ -157,7 +157,11 @@ function renderHtmlInline(ctx, pkg, content, paraId) {
 	return out;
 }
 function renderHtmlChildren(ctx, pkg, children, paraId) {
-	return children.map((c) => c.type === "run" ? renderHtmlRun(ctx, pkg, c, paraId) : renderHtmlHyperlink(ctx, pkg, c, paraId)).join("");
+	return children.map((child) => {
+		if (child.type === "run") return renderHtmlRun(ctx, pkg, child, paraId);
+		if (child.type === "hyperlink") return renderHtmlHyperlink(ctx, pkg, child, paraId);
+		return "";
+	}).join("");
 }
 function renderHtmlRun(ctx, pkg, run, paraId) {
 	if (run.formatting?.hidden) return "";

package/dist/model.d.ts

@@ -1,11 +1,11 @@
 import { document_d_exports } from "./types/document.js";
-import { DeriveBlockIdInput, FolioBlockId, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
+import { DeriveBlockIdInput, FolioBlockId, deriveBlankBlockId, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isBlankFolioBlockId, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
 import { BORDER_STYLE_VALUES, CONDITIONAL_STYLE_TYPE_VALUES, EMPHASIS_MARK_VALUES, FIELD_TYPE_VALUES, FLOATING_TABLE_X_SPEC_VALUES, FLOATING_TABLE_Y_SPEC_VALUES, FONT_HINT_VALUES, FONT_THEME_VALUES, FRAME_WRAP_VALUES, FRAME_X_ALIGN_VALUES, FRAME_Y_ALIGN_VALUES, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LEVEL_SUFFIX_VALUES, LINE_SPACING_RULE_VALUES, NUMBER_FORMAT_VALUES, OUTLINE_STYLE_ATTR_VALUES, OUTLINE_STYLE_CSS_ALIASES, OUTLINE_STYLE_CSS_ALIAS_VALUES, OutlineStyleAttr, OutlineStyleCssAlias, PARAGRAPH_ALIGNMENT_VALUES, POSITIONAL_TAB_ALIGNMENT_VALUES, POSITIONAL_TAB_LEADER_VALUES, POSITIONAL_TAB_RELATIVE_TO_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_OUTLINE_STYLE_VALUES, SHAPE_TEXT_ANCHOR_VALUES, SHAPE_TYPE_VALUES, STYLE_TYPE_VALUES, TABLE_CELL_TEXT_DIRECTION_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_EFFECT_VALUES, THEME_COLOR_SLOT_VALUES, UNDERLINE_STYLE_VALUES, normalizeShapeTextAnchor } from "./types/documentEnumValues.js";
 import { types_d_exports } from "./layout-engine/types.js";
 import { measureTypes_d_exports } from "./layout-engine/measure/measureTypes.js";
 export * from "@stll/docx-core/model";
 declare namespace model_d_exports {
-  export { BORDER_STYLE_VALUES, CONDITIONAL_STYLE_TYPE_VALUES, DeriveBlockIdInput, EMPHASIS_MARK_VALUES, FIELD_TYPE_VALUES, FLOATING_TABLE_X_SPEC_VALUES, FLOATING_TABLE_Y_SPEC_VALUES, FONT_HINT_VALUES, FONT_THEME_VALUES, FRAME_WRAP_VALUES, FRAME_X_ALIGN_VALUES, FRAME_Y_ALIGN_VALUES, FolioBlockId, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LEVEL_SUFFIX_VALUES, LINE_SPACING_RULE_VALUES, types_d_exports as Layout, measureTypes_d_exports as Measure, NUMBER_FORMAT_VALUES, OUTLINE_STYLE_ATTR_VALUES, OUTLINE_STYLE_CSS_ALIASES, OUTLINE_STYLE_CSS_ALIAS_VALUES, OutlineStyleAttr, OutlineStyleCssAlias, PARAGRAPH_ALIGNMENT_VALUES, POSITIONAL_TAB_ALIGNMENT_VALUES, POSITIONAL_TAB_LEADER_VALUES, POSITIONAL_TAB_RELATIVE_TO_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_OUTLINE_STYLE_VALUES, SHAPE_TEXT_ANCHOR_VALUES, SHAPE_TYPE_VALUES, STYLE_TYPE_VALUES, TABLE_CELL_TEXT_DIRECTION_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_EFFECT_VALUES, THEME_COLOR_SLOT_VALUES, UNDERLINE_STYLE_VALUES, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isFolioBlockId, isSequentialFolioBlockId, normalizeShapeTextAnchor };
+  export { BORDER_STYLE_VALUES, CONDITIONAL_STYLE_TYPE_VALUES, DeriveBlockIdInput, EMPHASIS_MARK_VALUES, FIELD_TYPE_VALUES, FLOATING_TABLE_X_SPEC_VALUES, FLOATING_TABLE_Y_SPEC_VALUES, FONT_HINT_VALUES, FONT_THEME_VALUES, FRAME_WRAP_VALUES, FRAME_X_ALIGN_VALUES, FRAME_Y_ALIGN_VALUES, FolioBlockId, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LEVEL_SUFFIX_VALUES, LINE_SPACING_RULE_VALUES, types_d_exports as Layout, measureTypes_d_exports as Measure, NUMBER_FORMAT_VALUES, OUTLINE_STYLE_ATTR_VALUES, OUTLINE_STYLE_CSS_ALIASES, OUTLINE_STYLE_CSS_ALIAS_VALUES, OutlineStyleAttr, OutlineStyleCssAlias, PARAGRAPH_ALIGNMENT_VALUES, POSITIONAL_TAB_ALIGNMENT_VALUES, POSITIONAL_TAB_LEADER_VALUES, POSITIONAL_TAB_RELATIVE_TO_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_OUTLINE_STYLE_VALUES, SHAPE_TEXT_ANCHOR_VALUES, SHAPE_TYPE_VALUES, STYLE_TYPE_VALUES, TABLE_CELL_TEXT_DIRECTION_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_EFFECT_VALUES, THEME_COLOR_SLOT_VALUES, UNDERLINE_STYLE_VALUES, deriveBlankBlockId, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isBlankFolioBlockId, isFolioBlockId, isSequentialFolioBlockId, normalizeShapeTextAnchor };
 }
 //#endregion
-export { BORDER_STYLE_VALUES, CONDITIONAL_STYLE_TYPE_VALUES, DeriveBlockIdInput, EMPHASIS_MARK_VALUES, FIELD_TYPE_VALUES, FLOATING_TABLE_X_SPEC_VALUES, FLOATING_TABLE_Y_SPEC_VALUES, FONT_HINT_VALUES, FONT_THEME_VALUES, FRAME_WRAP_VALUES, FRAME_X_ALIGN_VALUES, FRAME_Y_ALIGN_VALUES, FolioBlockId, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LEVEL_SUFFIX_VALUES, LINE_SPACING_RULE_VALUES, types_d_exports as Layout, type measureTypes_d_exports as Measure, NUMBER_FORMAT_VALUES, OUTLINE_STYLE_ATTR_VALUES, OUTLINE_STYLE_CSS_ALIASES, OUTLINE_STYLE_CSS_ALIAS_VALUES, OutlineStyleAttr, OutlineStyleCssAlias, PARAGRAPH_ALIGNMENT_VALUES, POSITIONAL_TAB_ALIGNMENT_VALUES, POSITIONAL_TAB_LEADER_VALUES, POSITIONAL_TAB_RELATIVE_TO_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_OUTLINE_STYLE_VALUES, SHAPE_TEXT_ANCHOR_VALUES, SHAPE_TYPE_VALUES, STYLE_TYPE_VALUES, TABLE_CELL_TEXT_DIRECTION_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_EFFECT_VALUES, THEME_COLOR_SLOT_VALUES, UNDERLINE_STYLE_VALUES, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isFolioBlockId, isSequentialFolioBlockId, normalizeShapeTextAnchor };
+export { BORDER_STYLE_VALUES, CONDITIONAL_STYLE_TYPE_VALUES, DeriveBlockIdInput, EMPHASIS_MARK_VALUES, FIELD_TYPE_VALUES, FLOATING_TABLE_X_SPEC_VALUES, FLOATING_TABLE_Y_SPEC_VALUES, FONT_HINT_VALUES, FONT_THEME_VALUES, FRAME_WRAP_VALUES, FRAME_X_ALIGN_VALUES, FRAME_Y_ALIGN_VALUES, FolioBlockId, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LEVEL_SUFFIX_VALUES, LINE_SPACING_RULE_VALUES, types_d_exports as Layout, type measureTypes_d_exports as Measure, NUMBER_FORMAT_VALUES, OUTLINE_STYLE_ATTR_VALUES, OUTLINE_STYLE_CSS_ALIASES, OUTLINE_STYLE_CSS_ALIAS_VALUES, OutlineStyleAttr, OutlineStyleCssAlias, PARAGRAPH_ALIGNMENT_VALUES, POSITIONAL_TAB_ALIGNMENT_VALUES, POSITIONAL_TAB_LEADER_VALUES, POSITIONAL_TAB_RELATIVE_TO_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_OUTLINE_STYLE_VALUES, SHAPE_TEXT_ANCHOR_VALUES, SHAPE_TYPE_VALUES, STYLE_TYPE_VALUES, TABLE_CELL_TEXT_DIRECTION_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_EFFECT_VALUES, THEME_COLOR_SLOT_VALUES, UNDERLINE_STYLE_VALUES, deriveBlankBlockId, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isBlankFolioBlockId, isFolioBlockId, isSequentialFolioBlockId, normalizeShapeTextAnchor };

package/dist/model.js

@@ -1,4 +1,4 @@
 import { types_exports } from "./layout-engine/types.js";
-import { deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
+import { deriveBlankBlockId, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isBlankFolioBlockId, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
 import { BORDER_STYLE_VALUES, CONDITIONAL_STYLE_TYPE_VALUES, EMPHASIS_MARK_VALUES, FIELD_TYPE_VALUES, FLOATING_TABLE_X_SPEC_VALUES, FLOATING_TABLE_Y_SPEC_VALUES, FONT_HINT_VALUES, FONT_THEME_VALUES, FRAME_WRAP_VALUES, FRAME_X_ALIGN_VALUES, FRAME_Y_ALIGN_VALUES, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LEVEL_SUFFIX_VALUES, LINE_SPACING_RULE_VALUES, NUMBER_FORMAT_VALUES, OUTLINE_STYLE_ATTR_VALUES, OUTLINE_STYLE_CSS_ALIASES, OUTLINE_STYLE_CSS_ALIAS_VALUES, PARAGRAPH_ALIGNMENT_VALUES, POSITIONAL_TAB_ALIGNMENT_VALUES, POSITIONAL_TAB_LEADER_VALUES, POSITIONAL_TAB_RELATIVE_TO_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_OUTLINE_STYLE_VALUES, SHAPE_TEXT_ANCHOR_VALUES, SHAPE_TYPE_VALUES, STYLE_TYPE_VALUES, TABLE_CELL_TEXT_DIRECTION_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_EFFECT_VALUES, THEME_COLOR_SLOT_VALUES, UNDERLINE_STYLE_VALUES, normalizeShapeTextAnchor } from "./types/documentEnumValues.js";
-export { BORDER_STYLE_VALUES, CONDITIONAL_STYLE_TYPE_VALUES, EMPHASIS_MARK_VALUES, FIELD_TYPE_VALUES, FLOATING_TABLE_X_SPEC_VALUES, FLOATING_TABLE_Y_SPEC_VALUES, FONT_HINT_VALUES, FONT_THEME_VALUES, FRAME_WRAP_VALUES, FRAME_X_ALIGN_VALUES, FRAME_Y_ALIGN_VALUES, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LEVEL_SUFFIX_VALUES, LINE_SPACING_RULE_VALUES, types_exports as Layout, NUMBER_FORMAT_VALUES, OUTLINE_STYLE_ATTR_VALUES, OUTLINE_STYLE_CSS_ALIASES, OUTLINE_STYLE_CSS_ALIAS_VALUES, PARAGRAPH_ALIGNMENT_VALUES, POSITIONAL_TAB_ALIGNMENT_VALUES, POSITIONAL_TAB_LEADER_VALUES, POSITIONAL_TAB_RELATIVE_TO_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_OUTLINE_STYLE_VALUES, SHAPE_TEXT_ANCHOR_VALUES, SHAPE_TYPE_VALUES, STYLE_TYPE_VALUES, TABLE_CELL_TEXT_DIRECTION_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_EFFECT_VALUES, THEME_COLOR_SLOT_VALUES, UNDERLINE_STYLE_VALUES, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isFolioBlockId, isSequentialFolioBlockId, normalizeShapeTextAnchor };
+export { BORDER_STYLE_VALUES, CONDITIONAL_STYLE_TYPE_VALUES, EMPHASIS_MARK_VALUES, FIELD_TYPE_VALUES, FLOATING_TABLE_X_SPEC_VALUES, FLOATING_TABLE_Y_SPEC_VALUES, FONT_HINT_VALUES, FONT_THEME_VALUES, FRAME_WRAP_VALUES, FRAME_X_ALIGN_VALUES, FRAME_Y_ALIGN_VALUES, HIGHLIGHT_COLOR_VALUES, IMAGE_HORIZONTAL_ALIGNMENT_VALUES, IMAGE_HORIZONTAL_RELATIVE_TO_VALUES, IMAGE_VERTICAL_ALIGNMENT_VALUES, IMAGE_VERTICAL_RELATIVE_TO_VALUES, IMAGE_WRAP_TEXT_VALUES, IMAGE_WRAP_TYPE_VALUES, LEVEL_SUFFIX_VALUES, LINE_SPACING_RULE_VALUES, types_exports as Layout, NUMBER_FORMAT_VALUES, OUTLINE_STYLE_ATTR_VALUES, OUTLINE_STYLE_CSS_ALIASES, OUTLINE_STYLE_CSS_ALIAS_VALUES, PARAGRAPH_ALIGNMENT_VALUES, POSITIONAL_TAB_ALIGNMENT_VALUES, POSITIONAL_TAB_LEADER_VALUES, POSITIONAL_TAB_RELATIVE_TO_VALUES, SDT_LOCK_VALUES, SDT_TYPE_VALUES, SHADING_PATTERN_VALUES, SHAPE_OUTLINE_STYLE_VALUES, SHAPE_TEXT_ANCHOR_VALUES, SHAPE_TYPE_VALUES, STYLE_TYPE_VALUES, TABLE_CELL_TEXT_DIRECTION_VALUES, TABLE_CELL_VERTICAL_ALIGNMENT_VALUES, TABLE_JUSTIFICATION_VALUES, TABLE_ROW_HEIGHT_RULE_VALUES, TABLE_WIDTH_TYPE_VALUES, TAB_LEADER_VALUES, TAB_STOP_ALIGNMENT_VALUES, TEXT_EFFECT_VALUES, THEME_COLOR_SLOT_VALUES, UNDERLINE_STYLE_VALUES, deriveBlankBlockId, deriveBlockId, getFolioParaIdFromBlockId, getSequentialFolioBlockIdIndex, isBlankFolioBlockId, isFolioBlockId, isSequentialFolioBlockId, normalizeShapeTextAnchor };

package/dist/pdf/contentStream.d.ts

@@ -0,0 +1,73 @@
+import { DisplayColor } from "../display-list/types.js";
+import { PdfMatrix } from "./pageSpace.js";
+//#region src/pdf/contentStream.d.ts
+type PdfResourceUse = {
+  readonly kind: "font";
+  readonly resourceIndex: number;
+} | {
+  readonly kind: "image";
+  readonly imageIndex: number;
+} | {
+  readonly kind: "extGState";
+  readonly alpha: number;
+};
+type ContentPart = {
+  readonly kind: "literal";
+  readonly text: string;
+} | PdfResourceUse;
+/** A glyph plus the correction that follows it in a `TJ` array. */
+type PositionedGlyph = {
+  readonly glyphId: number;
+  /** Thousandths of text space, subtracted from the pen after the glyph. */
+  readonly adjustment: number;
+};
+/**
+ * Text rendering modes. `fillThenStroke` is what an outlined run (`w:outline`)
+ * paints.
+ */
+declare const TEXT_RENDER_MODE: {
+  readonly fill: 0;
+  readonly stroke: 1;
+  readonly fillThenStroke: 2;
+};
+type PdfTextRenderMode = (typeof TEXT_RENDER_MODE)[keyof typeof TEXT_RENDER_MODE];
+type ContentStream = {
+  readonly save: () => void;
+  readonly restore: () => void;
+  readonly concat: (matrix: PdfMatrix) => void;
+  readonly setFillColor: (color: DisplayColor) => void;
+  readonly setStrokeColor: (color: DisplayColor) => void;
+  readonly setLineWidth: (widthPx: number) => void;
+  readonly setDash: (pattern: readonly number[], phasePx: number) => void;
+  /** Selects an `ExtGState` carrying `/ca` and `/CA` set to `alpha`. */
+  readonly setAlpha: (alpha: number) => void;
+  readonly appendRect: (xPx: number, yPx: number, widthPx: number, heightPx: number) => void;
+  readonly moveTo: (xPx: number, yPx: number) => void;
+  readonly lineTo: (xPx: number, yPx: number) => void;
+  readonly fill: () => void;
+  readonly stroke: () => void;
+  readonly clipToCurrentPath: () => void;
+  readonly beginText: () => void;
+  readonly endText: () => void;
+  readonly setFont: (resourceIndex: number, sizePx: number) => void;
+  readonly setTextRenderMode: (mode: PdfTextRenderMode) => void;
+  readonly setTextMatrix: (matrix: PdfMatrix) => void;
+  readonly showGlyphs: (glyphs: readonly PositionedGlyph[]) => void;
+  /** Shows one already-encoded byte string, for a simple (base-14) font. */
+  readonly showBytes: (bytes: readonly number[]) => void;
+  readonly drawImage: (imageIndex: number) => void;
+  readonly parts: () => readonly ContentPart[];
+};
+declare const createContentStream: () => ContentStream;
+/** Resource names for one page, assigned from sorted keys. */
+type ContentResources = {
+  /** Keyed by font resource index: one face can hold several of them. */
+  readonly fontNames: ReadonlyMap<number, string>;
+  readonly imageNames: ReadonlyMap<number, string>;
+  /** Keyed by the formatted alpha, so two alphas that print alike share a state. */
+  readonly extGStateNames: ReadonlyMap<string, string>;
+};
+declare const collectResources: (parts: readonly ContentPart[]) => ContentResources;
+declare const renderContentStream: (parts: readonly ContentPart[], resources: ContentResources) => string;
+//#endregion
+export { ContentPart, ContentResources, ContentStream, PdfResourceUse, PdfTextRenderMode, PositionedGlyph, TEXT_RENDER_MODE, collectResources, createContentStream, renderContentStream };

package/dist/pdf/contentStream.js

@@ -0,0 +1,143 @@
+import { formatNumber } from "./objects.js";
+import { panic } from "better-result";
+//#region src/pdf/contentStream.ts
+/**
+* Content-stream construction: the graphics operators, and the resource
+* names they refer to.
+*
+* A stream is built as a list of parts rather than a string, because a
+* resource reference (`/F1`, `/Im1`, `/GS1`) is written as a *use* of a font,
+* image or alpha, not as a name. Names are assigned once the whole stream is
+* known, in sorted key order, so nothing about the file depends on the order
+* in which the painter happened to reach a resource. Emitting names as the
+* painter goes would make the bytes depend on traversal order, which is
+* exactly the kind of drift the determinism requirement forbids.
+*/
+/**
+* Text rendering modes. `fillThenStroke` is what an outlined run (`w:outline`)
+* paints.
+*/
+const TEXT_RENDER_MODE = {
+	fill: 0,
+	stroke: 1,
+	fillThenStroke: 2
+};
+const COLOR_MAX = 255;
+const colorComponents = (color) => `${formatNumber(color.r / COLOR_MAX)} ${formatNumber(color.g / COLOR_MAX)} ${formatNumber(color.b / COLOR_MAX)}`;
+const glyphHex = (glyphId) => {
+	if (!Number.isInteger(glyphId) || glyphId < 0 || glyphId > 65535) panic(`glyph id outside Identity-H's two-byte range: ${String(glyphId)}`);
+	return glyphId.toString(16).padStart(4, "0").toUpperCase();
+};
+const createContentStream = () => {
+	const parts = [];
+	const line = (text) => {
+		parts.push({
+			kind: "literal",
+			text: `${text}\n`
+		});
+	};
+	const use = (resource, suffix) => {
+		parts.push(resource, {
+			kind: "literal",
+			text: `${suffix}\n`
+		});
+	};
+	return {
+		save: () => line("q"),
+		restore: () => line("Q"),
+		concat: (matrix) => line(`${matrix.map(formatNumber).join(" ")} cm`),
+		setFillColor: (color) => line(`${colorComponents(color)} rg`),
+		setStrokeColor: (color) => line(`${colorComponents(color)} RG`),
+		setLineWidth: (widthPx) => line(`${formatNumber(widthPx)} w`),
+		setDash: (pattern, phasePx) => line(`[${pattern.map(formatNumber).join(" ")}] ${formatNumber(phasePx)} d`),
+		setAlpha: (alpha) => use({
+			kind: "extGState",
+			alpha
+		}, " gs"),
+		appendRect: (xPx, yPx, widthPx, heightPx) => line(`${formatNumber(xPx)} ${formatNumber(yPx)} ${formatNumber(widthPx)} ${formatNumber(heightPx)} re`),
+		moveTo: (xPx, yPx) => line(`${formatNumber(xPx)} ${formatNumber(yPx)} m`),
+		lineTo: (xPx, yPx) => line(`${formatNumber(xPx)} ${formatNumber(yPx)} l`),
+		fill: () => line("f"),
+		stroke: () => line("S"),
+		clipToCurrentPath: () => line("W n"),
+		beginText: () => line("BT"),
+		endText: () => line("ET"),
+		setFont: (resourceIndex, sizePx) => use({
+			kind: "font",
+			resourceIndex
+		}, ` ${formatNumber(sizePx)} Tf`),
+		setTextRenderMode: (mode) => line(`${String(mode)} Tr`),
+		setTextMatrix: (matrix) => line(`${matrix.map(formatNumber).join(" ")} Tm`),
+		showGlyphs: (glyphs) => {
+			let body = "";
+			let pending = "";
+			for (const { glyphId, adjustment } of glyphs) {
+				pending += glyphHex(glyphId);
+				const formatted = formatNumber(adjustment);
+				if (formatted !== "0") {
+					body += `<${pending}>${formatted}`;
+					pending = "";
+				}
+			}
+			if (pending !== "") body += `<${pending}>`;
+			line(`[${body}] TJ`);
+		},
+		showBytes: (bytes) => {
+			let text = "";
+			for (const byte of bytes) if (byte === 40 || byte === 41 || byte === 92) text += `\\${String.fromCharCode(byte)}`;
+			else if (byte < 32 || byte > 126) text += `\\${byte.toString(8).padStart(3, "0")}`;
+			else text += String.fromCharCode(byte);
+			line(`(${text}) Tj`);
+		},
+		drawImage: (imageIndex) => use({
+			kind: "image",
+			imageIndex
+		}, " Do"),
+		parts: () => parts
+	};
+};
+const collectResources = (parts) => {
+	const fonts = /* @__PURE__ */ new Set();
+	const images = /* @__PURE__ */ new Set();
+	const alphas = /* @__PURE__ */ new Set();
+	for (const part of parts) switch (part.kind) {
+		case "literal": break;
+		case "font":
+			fonts.add(part.resourceIndex);
+			break;
+		case "image":
+			images.add(part.imageIndex);
+			break;
+		case "extGState":
+			alphas.add(formatNumber(part.alpha));
+			break;
+		default: panic(`unhandled content part: ${JSON.stringify(part)}`);
+	}
+	const numberNames = (keys, prefix) => new Map([...keys].sort((left, right) => left - right).map((key, index) => [key, `${prefix}${String(index + 1)}`]));
+	return {
+		fontNames: numberNames(fonts, "F"),
+		imageNames: numberNames(images, "Im"),
+		extGStateNames: new Map([...alphas].sort((left, right) => Number(left) - Number(right)).map((key, index) => [key, `GS${String(index + 1)}`]))
+	};
+};
+const renderContentStream = (parts, resources) => {
+	let out = "";
+	for (const part of parts) switch (part.kind) {
+		case "literal":
+			out += part.text;
+			break;
+		case "font":
+			out += `/${resources.fontNames.get(part.resourceIndex) ?? panic("unnamed font resource")}`;
+			break;
+		case "image":
+			out += `/${resources.imageNames.get(part.imageIndex) ?? panic("unnamed image resource")}`;
+			break;
+		case "extGState":
+			out += `/${resources.extGStateNames.get(formatNumber(part.alpha)) ?? panic("unnamed graphics state")}`;
+			break;
+		default: panic(`unhandled content part: ${JSON.stringify(part)}`);
+	}
+	return out;
+};
+//#endregion
+export { TEXT_RENDER_MODE, collectResources, createContentStream, renderContentStream };

package/dist/pdf/fonts.d.ts

@@ -0,0 +1,96 @@
+import { DisplayFontFace } from "../display-list/types.js";
+import { Shaper, ShapingDirection } from "../shaping/shaper.js";
+import { PdfDocument, PdfRef } from "./objects.js";
+import { PdfUnencodable } from "./writePdf.js";
+//#region src/pdf/fonts.d.ts
+type PdfFontSource = {
+  /**
+   * Every binary that carries part of this face, in priority order. A code
+   * point is served by the first binary whose cmap covers it.
+   */
+  readonly load: (face: DisplayFontFace) => readonly Uint8Array[];
+};
+type PdfSubstitution = {
+  readonly family: string;
+  readonly weight: number;
+  readonly italic: boolean;
+  readonly reason: string;
+};
+/** A code point placed in the glyph space of the resource that serves it. */
+type PdfGlyph = {
+  /** The PDF font resource this glyph id belongs to. */
+  readonly resourceIndex: number;
+  readonly glyphId: number;
+  /** The width this file declares for the glyph, in 1000ths of an em. */
+  readonly widthUnits: number;
+};
+/**
+ * One face, ready to paint. The two branches differ in how a code point
+ * reaches the page, so the painter switches on `kind` rather than carrying
+ * optional fields that are only valid in one of them.
+ */
+/** One shaped glyph, in the glyph space of the resource that will paint it. */
+type PlacedPdfGlyph = PdfGlyph & {
+  /** Code-point index in the run's text of the cluster this glyph came from. */
+  readonly clusterIndex: number;
+  readonly xAdvancePx: number;
+  readonly xOffsetPx: number;
+  readonly yOffsetPx: number;
+};
+/** A run whose glyphs shaping has to choose, as the collection pass saw it. */
+type ShapedRunRequest = {
+  readonly text: string;
+  readonly direction: ShapingDirection;
+  readonly fontSizePx: number;
+};
+/** A face embedded as a subset of its own program. */
+type EmbeddedPdfFont = {
+  readonly kind: "embedded";
+  /** Resource and subset glyph for a code point the collection pass saw. */
+  readonly glyphFor: (codePoint: number) => PdfGlyph;
+  /**
+   * The glyphs shaping chose for a run, in visual order, or `null` when this
+   * run was not shaped: no shaper was resolved, or the run is in a script where
+   * a code point selects its own glyph.
+   */
+  readonly placeShapedRun: (request: ShapedRunRequest) => readonly PlacedPdfGlyph[] | null;
+};
+/** A base-14 stand-in for a face that could not be embedded. */
+type StandardPdfFont = {
+  readonly kind: "standard";
+  readonly resourceIndex: number;
+  /** WinAnsi byte for a code point. */
+  readonly byteFor: (codePoint: number) => number;
+};
+type PreparedFont = EmbeddedPdfFont | StandardPdfFont;
+type PrepareFontsOptions = {
+  readonly document: PdfDocument;
+  readonly faces: readonly DisplayFontFace[];
+  /** Font index to the code points the document paints from that face. */
+  readonly usedCodePoints: ReadonlyMap<number, ReadonlySet<number>>;
+  /** Font index to the runs whose glyphs shaping has to choose. */
+  readonly shapedRuns?: ReadonlyMap<number, readonly ShapedRunRequest[]>;
+  /**
+   * The shaper, when the document contains a run that needs one. Absent leaves
+   * such runs painted one glyph per code point, which the scripts that shape do
+   * not read as; the caller resolves a shaper whenever the display list has
+   * one, which is what keeps the artifact off the path of a Latin document.
+   */
+  readonly shaper?: Shaper | null;
+  readonly source: PdfFontSource;
+};
+type PreparedFonts = {
+  readonly byFontIndex: ReadonlyMap<number, PreparedFont>;
+  /** Every PDF font resource the pages may name, by resource index. */
+  readonly fontRefByResourceIndex: ReadonlyMap<number, PdfRef>;
+  readonly substitutions: readonly PdfSubstitution[];
+  readonly unencodable: readonly PdfUnencodable[];
+};
+/**
+ * Turns the display list's font table into PDF font objects. A face nothing
+ * paints is skipped entirely: an unused face is not a substitution, and
+ * embedding it would put bytes in the file no page reads.
+ */
+declare const prepareFonts: ({ document, faces, usedCodePoints, shapedRuns, shaper, source }: PrepareFontsOptions) => PreparedFonts;
+//#endregion
+export { EmbeddedPdfFont, PdfFontSource, PdfGlyph, PdfSubstitution, PlacedPdfGlyph, PreparedFont, PreparedFonts, ShapedRunRequest, StandardPdfFont, prepareFonts };