@stll/folio-core 0.45.0 → 0.47.0

package/dist/pdf/images.js

@@ -12,9 +12,10 @@ import { inflateSync } from "node:zlib";
 * so a 4-bit palette image stays 4-bit and an alpha channel becomes an
 * `/SMask` rather than being composited against a guess at the backdrop.
 *
-* A form this module cannot represent exactly (16-bit samples, interlacing)
-* is an error, never an approximation: painting the wrong pixels silently is
-* worse than refusing the page.
+* A form this module cannot represent exactly (16-bit samples) is an error,
+* never an approximation: painting the wrong pixels silently is worse than
+* refusing the page. Adam7 interlacing is not such a form — it is seven
+* ordinary rasters of the same samples — so it is decoded rather than refused.
 */
 var PdfImageError = class extends TaggedError("PdfImageError") {};
 const PNG_SIGNATURE = [
@@ -43,6 +44,8 @@ const CHANNELS_PER_COLOR_TYPE = {
 };
 const FULLY_OPAQUE = 255;
 const EIGHT_BIT = 8;
+/** IHDR interlace method 1: the only one PNG defines besides "none". */
+const ADAM7_INTERLACE = 1;
 const toHex = (bytes) => {
 	let out = "";
 	for (const byte of bytes) out += byte.toString(16).padStart(2, "0").toUpperCase();
@@ -138,6 +141,131 @@ const unfilterPng = ({ filtered, bytesPerRow, bytesPerPixel, height }) => {
 	}
 	return Result.ok(out);
 };
+/**
+* The seven Adam7 passes, in the order the IDAT stream carries them: the
+* offset of the pass's first pixel and the stride between its pixels.
+*/
+const ADAM7_PASSES = [
+	{
+		xOffset: 0,
+		yOffset: 0,
+		xStep: 8,
+		yStep: 8
+	},
+	{
+		xOffset: 4,
+		yOffset: 0,
+		xStep: 8,
+		yStep: 8
+	},
+	{
+		xOffset: 0,
+		yOffset: 4,
+		xStep: 4,
+		yStep: 8
+	},
+	{
+		xOffset: 2,
+		yOffset: 0,
+		xStep: 4,
+		yStep: 4
+	},
+	{
+		xOffset: 0,
+		yOffset: 2,
+		xStep: 2,
+		yStep: 4
+	},
+	{
+		xOffset: 1,
+		yOffset: 0,
+		xStep: 2,
+		yStep: 2
+	},
+	{
+		xOffset: 0,
+		yOffset: 1,
+		xStep: 1,
+		yStep: 2
+	}
+];
+/**
+* The passes that carry data, with their own geometry.
+*
+* A narrow or short image leaves later passes empty — a 1x1 image has only
+* pass 1 — and an empty pass contributes no bytes at all, not even a filter
+* byte, so it must be dropped rather than read as a zero-row raster.
+*/
+const adam7Passes = (width, height, bitsPerPixel) => {
+	const passes = [];
+	for (const { xOffset, yOffset, xStep, yStep } of ADAM7_PASSES) {
+		const passWidth = Math.ceil(Math.max(0, width - xOffset) / xStep);
+		const passHeight = Math.ceil(Math.max(0, height - yOffset) / yStep);
+		if (passWidth === 0 || passHeight === 0) continue;
+		passes.push({
+			xOffset,
+			yOffset,
+			xStep,
+			yStep,
+			width: passWidth,
+			height: passHeight,
+			bytesPerRow: Math.ceil(bitsPerPixel * passWidth / EIGHT_BIT)
+		});
+	}
+	return passes;
+};
+/** One filter byte per row of every pass: the whole inflated size Adam7 needs. */
+const adam7FilteredBytes = (passes) => passes.reduce((sum, pass) => sum + pass.height * (pass.bytesPerRow + 1), 0);
+/** Write one unfiltered pass into the pixels of the full raster it owns. */
+const scatterPass = ({ pass, rows, out, bytesPerRow, bitDepth, bytesPerPixel }) => {
+	if (bitDepth >= EIGHT_BIT) {
+		for (let row = 0; row < pass.height; row += 1) {
+			const targetRow = pass.yOffset + row * pass.yStep;
+			for (let column = 0; column < pass.width; column += 1) {
+				const source = row * pass.bytesPerRow + column * bytesPerPixel;
+				const target = targetRow * bytesPerRow + (pass.xOffset + column * pass.xStep) * bytesPerPixel;
+				for (let byte = 0; byte < bytesPerPixel; byte += 1) out[target + byte] = rows[source + byte] ?? 0;
+			}
+		}
+		return;
+	}
+	const perByte = EIGHT_BIT / bitDepth;
+	const mask = (1 << bitDepth) - 1;
+	for (let row = 0; row < pass.height; row += 1) {
+		const targetRow = pass.yOffset + row * pass.yStep;
+		for (let column = 0; column < pass.width; column += 1) {
+			const value = (rows[row * pass.bytesPerRow + Math.floor(column / perByte)] ?? 0) >> EIGHT_BIT - bitDepth * (column % perByte + 1) & mask;
+			const targetColumn = pass.xOffset + column * pass.xStep;
+			const targetIndex = targetRow * bytesPerRow + Math.floor(targetColumn / perByte);
+			const targetShift = EIGHT_BIT - bitDepth * (targetColumn % perByte + 1);
+			out[targetIndex] = (out[targetIndex] ?? 0) & ~(mask << targetShift) | value << targetShift;
+		}
+	}
+};
+/** Unfilter each Adam7 pass and scatter it into the raster it describes. */
+const deinterlacePng = ({ filtered, passes, height, bytesPerRow, bytesPerPixel, bitDepth }) => {
+	const out = new Uint8Array(height * bytesPerRow);
+	let cursor = 0;
+	for (const pass of passes) {
+		const unfiltered = unfilterPng({
+			filtered: filtered.subarray(cursor),
+			bytesPerRow: pass.bytesPerRow,
+			bytesPerPixel,
+			height: pass.height
+		});
+		if (unfiltered.isErr()) return Result.err(unfiltered.error);
+		scatterPass({
+			pass,
+			rows: unfiltered.value,
+			out,
+			bytesPerRow,
+			bitDepth,
+			bytesPerPixel
+		});
+		cursor += pass.height * (pass.bytesPerRow + 1);
+	}
+	return Result.ok(out);
+};
 /** One byte per pixel index, for sub-byte palette and greyscale depths. */
 const expandIndices = ({ rows, bytesPerRow, width, height, bitDepth }) => {
 	if (bitDepth === EIGHT_BIT) return rows;
@@ -162,7 +290,7 @@ const decodePng = (bytes) => {
 	const colorType = header[9] ?? 0;
 	const interlace = header[12] ?? 0;
 	if (width === 0 || height === 0) return Result.err(new PdfImageError({ message: "PNG has a zero dimension" }));
-	if (interlace !== 0) return Result.err(new PdfImageError({ message: "interlaced PNG is not supported" }));
+	if (interlace !== 0 && interlace !== ADAM7_INTERLACE) return Result.err(new PdfImageError({ message: `unknown PNG interlace method ${String(interlace)}` }));
 	const channels = CHANNELS_PER_COLOR_TYPE[colorType];
 	if (channels === void 0) return Result.err(new PdfImageError({ message: `unknown PNG colour type ${String(colorType)}` }));
 	if (!(colorType === PNG_COLOR_TYPE.greyscale || colorType === PNG_COLOR_TYPE.palette ? [
@@ -174,18 +302,26 @@ const decodePng = (bytes) => {
 	const bitsPerPixel = bitDepth * channels;
 	const bytesPerRow = Math.ceil(bitsPerPixel * width / EIGHT_BIT);
 	const bytesPerPixel = Math.max(1, Math.ceil(bitsPerPixel / EIGHT_BIT));
-	const inflatedBytesExpected = height * (bytesPerRow + 1);
+	const passes = interlace === ADAM7_INTERLACE ? adam7Passes(width, height, bitsPerPixel) : null;
+	const inflatedBytesExpected = passes === null ? height * (bytesPerRow + 1) : adam7FilteredBytes(passes);
 	const inflated = Result.try({
 		try: () => inflateSync(pixels, { maxOutputLength: inflatedBytesExpected }),
 		catch: (cause) => new PdfImageError({ message: `PNG IDAT does not inflate to the ${String(inflatedBytesExpected)} bytes its IHDR declares: ${cause instanceof Error ? cause.message : String(cause)}` })
 	});
 	if (inflated.isErr()) return Result.err(inflated.error);
 	const filtered = new Uint8Array(inflated.value.buffer, inflated.value.byteOffset, inflated.value.byteLength);
-	const unfiltered = unfilterPng({
+	const unfiltered = passes === null ? unfilterPng({
 		filtered,
 		bytesPerRow,
 		bytesPerPixel,
 		height
+	}) : deinterlacePng({
+		filtered,
+		passes,
+		height,
+		bytesPerRow,
+		bytesPerPixel,
+		bitDepth
 	});
 	if (unfiltered.isErr()) return Result.err(unfiltered.error);
 	const rows = unfiltered.value;

package/dist/prosemirror/attrs/index.d.ts

@@ -1,5 +1,5 @@
-import { CharacterSpacingAttrs, CharacterStyleAttrs, CommentAttrs, EmphasisMarkAttrs, FontFamilyAttrs, FontSizeAttrs, FootnoteRefAttrs, HighlightAttrs, HyperlinkAttrs, LanguageAttrs, PageBreakRunOwnerMarkAttrs, RunFormattingOverrideAttrs, RunPropertyChangeMarkAttrs, RunShadingAttrs, StrikeAttrs, TextColorAttrs, TextEffectAttrs, TrackedChangeMarkAttrs, UnderlineAttrs } from "../schema/marks.js";
-import { BlockSdtAttrs, FieldAttrs, HardBreakAttrs, ImageAttrs, MathAttrs, PageBreakRunAttrs, ParagraphAttrs, SdtAttrs, ShapeAttrs, SymbolAttrs, TabAttrs, TableAttrs, TableCellAttrs, TableRowAttrs, TextBoxAttrs } from "../schema/nodes.js";
+import { CharacterSpacingAttrs, CharacterStyleAttrs, CommentAttrs, EmphasisMarkAttrs, FontFamilyAttrs, FontSizeAttrs, FootnoteRefAttrs, HighlightAttrs, HyperlinkAttrs, InlineWrapperAttrs, InlineWrapperLayer, LanguageAttrs, RunFormattingOverrideAttrs, RunIdentityMarkAttrs, RunPropertyChangeMarkAttrs, RunShadingAttrs, StrikeAttrs, TextColorAttrs, TextEffectAttrs, TrackedChangeMarkAttrs, UnderlineAttrs } from "../schema/marks.js";
+import { BlockSdtAttrs, FieldAttrs, HardBreakAttrs, ImageAttrs, MathAttrs, PageBreakRunAttrs, ParagraphAttrs, PreservedBlockAttrs, PreservedXmlAttrs, SdtAttrs, ShapeAttrs, SymbolAttrs, TabAttrs, TableAttrs, TableCellAttrs, TableRowAttrs, TextBoxAttrs } from "../schema/nodes.js";
 import "../schema/index.js";
 import { Mark, Node } from "prosemirror-model";
 //#region src/prosemirror/attrs/index.d.ts
@@ -24,6 +24,10 @@ declare const readTabAttrs: (node: Node) => ReadProseMirrorAttrsResult<TabAttrs>
 declare const expectTabAttrs: (node: Node) => TabAttrs;
 declare const readSymbolAttrs: (node: Node) => ReadProseMirrorAttrsResult<SymbolAttrs>;
 declare const expectSymbolAttrs: (node: Node) => SymbolAttrs;
+declare const readPreservedXmlAttrs: (node: Node) => ReadProseMirrorAttrsResult<PreservedXmlAttrs>;
+declare const expectPreservedXmlAttrs: (node: Node) => PreservedXmlAttrs;
+declare const readPreservedBlockAttrs: (node: Node) => ReadProseMirrorAttrsResult<PreservedBlockAttrs>;
+declare const expectPreservedBlockAttrs: (node: Node) => PreservedBlockAttrs;
 declare const readTableAttrs: (node: Node) => ReadProseMirrorAttrsResult<TableAttrs>;
 declare const expectTableAttrs: (node: Node) => TableAttrs;
 declare const readTableRowAttrs: (node: Node) => ReadProseMirrorAttrsResult<TableRowAttrs>;
@@ -76,8 +80,24 @@ declare const readTrackedChangeMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsRe
 declare const expectTrackedChangeMarkAttrs: (mark: Mark) => TrackedChangeMarkAttrs;
 declare const readRunPropertyChangeMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<RunPropertyChangeMarkAttrs>;
 declare const expectRunPropertyChangeMarkAttrs: (mark: Mark) => RunPropertyChangeMarkAttrs;
-declare const readPageBreakRunOwnerMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<PageBreakRunOwnerMarkAttrs>;
-declare const expectPageBreakRunOwnerMarkAttrs: (mark: Mark) => PageBreakRunOwnerMarkAttrs;
+/**
+ * The identity mark's payload, field by field.
+ *
+ * Every field is read strictly because the mark reaches this build from three
+ * places it does not control: a paste, a collaboration snapshot written by
+ * another build, and a host that edited the document through the public API.
+ * A remainder entry that is not a resolved name and a string value would be
+ * written straight back into a `w:r` start tag.
+ */
+declare const readRunIdentityMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<RunIdentityMarkAttrs>;
+declare const expectRunIdentityMarkAttrs: (mark: Mark) => RunIdentityMarkAttrs;
+/**
+ * A wrapper stack read from outside the editor — the DOM on paste, a stored
+ * snapshot — validated layer by layer.
+ */
+declare const readInlineWrapperStack: (value: unknown, path?: string) => ReadProseMirrorAttrsResult<readonly InlineWrapperLayer[]>;
+declare const readInlineWrapperMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<InlineWrapperAttrs>;
+declare const expectInlineWrapperMarkAttrs: (mark: Mark) => InlineWrapperAttrs;
 declare const readRunFormattingOverrideMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<RunFormattingOverrideAttrs>;
 declare const expectRunFormattingOverrideMarkAttrs: (mark: Mark) => RunFormattingOverrideAttrs;
 declare const readHyperlinkMarkAttrs: (mark: Mark) => ReadProseMirrorAttrsResult<HyperlinkAttrs>;
@@ -87,6 +107,15 @@ declare const mergeImageAttrs: (node: Node, patch: NodeAttrPatch<ImageAttrs>) =>
 declare const mergeParagraphAttrs: (node: Node, patch: NodeAttrPatch<ParagraphAttrs>) => ParagraphAttrs;
 declare const mergeTableAttrs: (node: Node, patch: NodeAttrPatch<TableAttrs>) => TableAttrs;
 declare const mergeTableRowAttrs: (node: Node, patch: NodeAttrPatch<TableRowAttrs>) => TableRowAttrs;
+/**
+ * A command that moves a cell's width states one.
+ *
+ * `width` is also where the table's resolved grid width lands for a cell that
+ * declares no `w:tcW`, so the save leg reads `_authoredWidth` instead. Deriving
+ * it here rather than at each command keeps the two from drifting: a command
+ * cannot set a width without recording that the cell now states it, and one
+ * that clears the width clears the record with it.
+ */
 declare const mergeTableCellAttrs: (node: Node, patch: NodeAttrPatch<TableCellAttrs>) => TableCellAttrs;
 //#endregion
-export { ProseMirrorAttrIssue, ReadProseMirrorAttrsResult, expectBlockSdtAttrs, expectCharacterSpacingMarkAttrs, expectCharacterStyleMarkAttrs, expectCommentMarkAttrs, expectEmphasisMarkAttrs, expectFieldAttrs, expectFontFamilyMarkAttrs, expectFontSizeMarkAttrs, expectFootnoteRefMarkAttrs, expectHardBreakAttrs, expectHighlightMarkAttrs, expectHyperlinkMarkAttrs, expectImageAttrs, expectLanguageMarkAttrs, expectMathAttrs, expectPageBreakRunAttrs, expectPageBreakRunOwnerMarkAttrs, expectParagraphAttrs, expectRunFormattingOverrideMarkAttrs, expectRunPropertyChangeMarkAttrs, expectRunShadingMarkAttrs, expectSdtAttrs, expectShapeAttrs, expectStrikeMarkAttrs, expectSymbolAttrs, expectTabAttrs, expectTableAttrs, expectTableCellAttrs, expectTableRowAttrs, expectTextBoxAttrs, expectTextColorMarkAttrs, expectTextEffectMarkAttrs, expectTrackedChangeMarkAttrs, expectUnderlineMarkAttrs, mergeImageAttrs, mergeParagraphAttrs, mergeTableAttrs, mergeTableCellAttrs, mergeTableRowAttrs, readBlockSdtAttrs, readCharacterSpacingMarkAttrs, readCharacterStyleMarkAttrs, readCommentMarkAttrs, readEmphasisMarkAttrs, readFieldAttrs, readFontFamilyMarkAttrs, readFontSizeMarkAttrs, readFootnoteRefMarkAttrs, readHardBreakAttrs, readHighlightMarkAttrs, readHyperlinkMarkAttrs, readImageAttrs, readLanguageMarkAttrs, readMathAttrs, readPageBreakRunAttrs, readPageBreakRunOwnerMarkAttrs, readParagraphAttrs, readRunFormattingOverrideMarkAttrs, readRunPropertyChangeMarkAttrs, readRunShadingMarkAttrs, readSdtAttrs, readShapeAttrs, readStrikeMarkAttrs, readSymbolAttrs, readTabAttrs, readTableAttrs, readTableCellAttrs, readTableRowAttrs, readTextBoxAttrs, readTextColorMarkAttrs, readTextEffectMarkAttrs, readTrackedChangeMarkAttrs, readUnderlineMarkAttrs };
+export { ProseMirrorAttrIssue, ReadProseMirrorAttrsResult, expectBlockSdtAttrs, expectCharacterSpacingMarkAttrs, expectCharacterStyleMarkAttrs, expectCommentMarkAttrs, expectEmphasisMarkAttrs, expectFieldAttrs, expectFontFamilyMarkAttrs, expectFontSizeMarkAttrs, expectFootnoteRefMarkAttrs, expectHardBreakAttrs, expectHighlightMarkAttrs, expectHyperlinkMarkAttrs, expectImageAttrs, expectInlineWrapperMarkAttrs, expectLanguageMarkAttrs, expectMathAttrs, expectPageBreakRunAttrs, expectParagraphAttrs, expectPreservedBlockAttrs, expectPreservedXmlAttrs, expectRunFormattingOverrideMarkAttrs, expectRunIdentityMarkAttrs, expectRunPropertyChangeMarkAttrs, expectRunShadingMarkAttrs, expectSdtAttrs, expectShapeAttrs, expectStrikeMarkAttrs, expectSymbolAttrs, expectTabAttrs, expectTableAttrs, expectTableCellAttrs, expectTableRowAttrs, expectTextBoxAttrs, expectTextColorMarkAttrs, expectTextEffectMarkAttrs, expectTrackedChangeMarkAttrs, expectUnderlineMarkAttrs, mergeImageAttrs, mergeParagraphAttrs, mergeTableAttrs, mergeTableCellAttrs, mergeTableRowAttrs, readBlockSdtAttrs, readCharacterSpacingMarkAttrs, readCharacterStyleMarkAttrs, readCommentMarkAttrs, readEmphasisMarkAttrs, readFieldAttrs, readFontFamilyMarkAttrs, readFontSizeMarkAttrs, readFootnoteRefMarkAttrs, readHardBreakAttrs, readHighlightMarkAttrs, readHyperlinkMarkAttrs, readImageAttrs, readInlineWrapperMarkAttrs, readInlineWrapperStack, readLanguageMarkAttrs, readMathAttrs, readPageBreakRunAttrs, readParagraphAttrs, readPreservedBlockAttrs, readPreservedXmlAttrs, readRunFormattingOverrideMarkAttrs, readRunIdentityMarkAttrs, readRunPropertyChangeMarkAttrs, readRunShadingMarkAttrs, readSdtAttrs, readShapeAttrs, readStrikeMarkAttrs, readSymbolAttrs, readTabAttrs, readTableAttrs, readTableCellAttrs, readTableRowAttrs, readTextBoxAttrs, readTextColorMarkAttrs, readTextEffectMarkAttrs, readTrackedChangeMarkAttrs, readUnderlineMarkAttrs };