wpd-codec 2.1.4 → 3.0.0

package/README.md

@@ -197,6 +197,7 @@ What the corpus settles:
 - **Two readings the specification does not settle, both chosen deliberately.** The Form function states its desired width and its desired length as two independent fields and its orientation as a third, and says nothing about whether the pair is written before or after the rotation — so a landscape form's dimensions go through exactly as written and the flag is reported through `wpd/landscape-orientation-unmapped` rather than rotated on this package's own inference. And a Table Column's `[width]` is the one horizontal dimension in the format the SDK does not tag `(WPU)`, so it is read as WordPerfect Units on the strength of the two gutter fields immediately after it, which are.
 - **Reading a document is not rendering one.** The corpus check confirms that each file reads, that its text is prose, and that the structures above are recovered; it does not compare the result against what WordPerfect itself would display, which would need a reference renderer this family does not have.
 - **The document-area's own file-size bound.** The header's file-size field is honoured only when self-consistent, because the SDK itself warns that a third-party writer failing to update it is a common real-world defect whose symptom is a document reading back blank.
+- **A partially-shaded cell fill's own compositing formula.** A cell whose foreground and background colours are blended at a shading percentage other than 0 or 255 now resolves to a real two-colour `pattern` `ContentCellFill` (ExaDev/documents.js#1024) rather than being flattened to its background colour alone, but the mirrored SDK pages document the RGBS byte layout, not how the shading byte composites the pair — so the background shade byte is read as that layer's own opacity and the foreground's implied coverage is snapped to the nearest `percentN` step `ContentCellPatternTypeSchema` defines, a derivation rather than a cited value. Reported through `wpd/cell-fill-blended`.
 
 ## Conventions
 

package/dist/read.cjs

@@ -125,11 +125,11 @@ function readCellAttributes(state, nonDeletable, sink) {
 	const row = require_stream_table.findEmbeddedSubfunction(subfunctions, 128);
 	const cellSpanning = spanning === void 0 ? void 0 : require_stream_table.readCellSpanning(spanning);
 	const cellFill = fill === void 0 ? void 0 : require_stream_table.readCellFill(fill);
-	if (cellFill?.blended === true) reportOnce(state, sink, require_diagnostics.WpdDiagnosticCodes.CellFillBlended, "A cell is filled with a shaded blend of two colours; its background colour is used and the blend is not reproduced.");
+	if (cellFill?.blended === true) reportOnce(state, sink, require_diagnostics.WpdDiagnosticCodes.CellFillBlended, "A cell is filled with a shaded blend of two colours, resolved to a 'pattern' fill whose density is this reader's own best-effort derivation, not a value confirmed against a specification.");
 	return {
 		attributes: {
 			alignment: information === void 0 ? void 0 : require_stream_table.readCellInformation(information)?.alignment,
-			background: cellFill?.background,
+			background: cellFill?.fill,
 			columnSpan: cellSpanning?.columnSpan ?? NO_SPAN,
 			rowSpan: cellSpanning?.rowSpan ?? NO_SPAN,
 			covered: cellSpanning?.coveredFromLeft === true || cellSpanning?.coveredFromAbove === true
@@ -149,10 +149,7 @@ function closeCell(state, table, attributes) {
 		blocks,
 		...attributes.columnSpan > NO_SPAN ? { colSpan: attributes.columnSpan } : {},
 		...attributes.rowSpan > NO_SPAN ? { rowSpan: attributes.rowSpan } : {},
-		...attributes.background === void 0 ? {} : { background: {
-			kind: "solid",
-			color: attributes.background
-		} }
+		...attributes.background === void 0 ? {} : { background: attributes.background }
 	};
 	table.cells.push(cell);
 }

package/dist/read.js

@@ -124,11 +124,11 @@ function readCellAttributes(state, nonDeletable, sink) {
 	const row = findEmbeddedSubfunction(subfunctions, 128);
 	const cellSpanning = spanning === void 0 ? void 0 : readCellSpanning(spanning);
 	const cellFill = fill === void 0 ? void 0 : readCellFill(fill);
-	if (cellFill?.blended === true) reportOnce(state, sink, WpdDiagnosticCodes.CellFillBlended, "A cell is filled with a shaded blend of two colours; its background colour is used and the blend is not reproduced.");
+	if (cellFill?.blended === true) reportOnce(state, sink, WpdDiagnosticCodes.CellFillBlended, "A cell is filled with a shaded blend of two colours, resolved to a 'pattern' fill whose density is this reader's own best-effort derivation, not a value confirmed against a specification.");
 	return {
 		attributes: {
 			alignment: information === void 0 ? void 0 : readCellInformation(information)?.alignment,
-			background: cellFill?.background,
+			background: cellFill?.fill,
 			columnSpan: cellSpanning?.columnSpan ?? NO_SPAN,
 			rowSpan: cellSpanning?.rowSpan ?? NO_SPAN,
 			covered: cellSpanning?.coveredFromLeft === true || cellSpanning?.coveredFromAbove === true
@@ -148,10 +148,7 @@ function closeCell(state, table, attributes) {
 		blocks,
 		...attributes.columnSpan > NO_SPAN ? { colSpan: attributes.columnSpan } : {},
 		...attributes.rowSpan > NO_SPAN ? { rowSpan: attributes.rowSpan } : {},
-		...attributes.background === void 0 ? {} : { background: {
-			kind: "solid",
-			color: attributes.background
-		} }
+		...attributes.background === void 0 ? {} : { background: attributes.background }
 	};
 	table.cells.push(cell);
 }

package/dist/stream/table.cjs

@@ -1,4 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_errors = require("../errors.cjs");
 const require_bytes_view = require("../bytes/view.cjs");
 const require_stream_units = require("./units.cjs");
 //#region src/stream/table.ts
@@ -123,6 +124,34 @@ function readCellSpanning(data) {
 const COLOR_COMPONENT_MAX = 255;
 const RGBS_SIZE = 4;
 const FULL_SHADE = 255;
+const PERCENT_STEPS = [
+	[5, "percent5"],
+	[10, "percent10"],
+	[12, "percent12"],
+	[15, "percent15"],
+	[20, "percent20"],
+	[25, "percent25"],
+	[30, "percent30"],
+	[35, "percent35"],
+	[37, "percent37"],
+	[40, "percent40"],
+	[45, "percent45"],
+	[50, "percent50"],
+	[55, "percent55"],
+	[60, "percent60"],
+	[62, "percent62"],
+	[65, "percent65"],
+	[70, "percent70"],
+	[75, "percent75"],
+	[80, "percent80"],
+	[85, "percent85"],
+	[87, "percent87"],
+	[90, "percent90"],
+	[95, "percent95"]
+];
+function nearestPercentType(percent) {
+	return PERCENT_STEPS.reduce((best, step) => Math.abs(step[0] - percent) < Math.abs(best[0] - percent) ? step : best)[1];
+}
 function colorAt(data, offset) {
 	const r = data[offset];
 	const g = data[offset + 1];
@@ -138,9 +167,23 @@ function readCellFill(data) {
 	const background = colorAt(data, RGBS_SIZE);
 	if (background === void 0) return;
 	const backgroundShade = data[7];
+	if (backgroundShade === void 0 || backgroundShade === FULL_SHADE) return {
+		fill: {
+			kind: "solid",
+			color: background
+		},
+		blended: false
+	};
+	const foreground = colorAt(data, 0);
+	if (foreground === void 0) throw new require_errors.WpdFormatError("Cell fill has a readable background colour but an unreadable foreground colour, which the RGBS pair's own contiguous layout should make impossible.");
 	return {
-		background,
-		blended: backgroundShade !== void 0 && backgroundShade !== FULL_SHADE
+		fill: {
+			kind: "pattern",
+			patternType: nearestPercentType(100 - backgroundShade / COLOR_COMPONENT_MAX * 100),
+			foregroundColor: foreground,
+			backgroundColor: background
+		},
+		blended: true
 	};
 }
 //#endregion

package/dist/stream/table.d.cts

@@ -1,4 +1,4 @@
-import { Alignment, Color } from "document-schema.js";
+import { Alignment, ContentCellFill } from "document-schema.js";
 //#region src/stream/table.d.ts
 declare const CHARACTER_TABLE_DEFINITION = 42;
 declare const CHARACTER_DEFINE_TABLE_END = 43;
@@ -35,7 +35,7 @@ interface WpdCellSpanning {
 }
 declare function readCellSpanning(data: Uint8Array): WpdCellSpanning | undefined;
 interface WpdCellFill {
-  readonly background: Color;
+  readonly fill: ContentCellFill;
   readonly blended: boolean;
 }
 declare function readCellFill(data: Uint8Array): WpdCellFill | undefined;

package/dist/stream/table.d.ts

@@ -1,4 +1,4 @@
-import { Alignment, Color } from "document-schema.js";
+import { Alignment, ContentCellFill } from "document-schema.js";
 //#region src/stream/table.d.ts
 declare const CHARACTER_TABLE_DEFINITION = 42;
 declare const CHARACTER_DEFINE_TABLE_END = 43;
@@ -35,7 +35,7 @@ interface WpdCellSpanning {
 }
 declare function readCellSpanning(data: Uint8Array): WpdCellSpanning | undefined;
 interface WpdCellFill {
-  readonly background: Color;
+  readonly fill: ContentCellFill;
   readonly blended: boolean;
 }
 declare function readCellFill(data: Uint8Array): WpdCellFill | undefined;

package/dist/stream/table.js

@@ -1,3 +1,4 @@
+import { WpdFormatError } from "../errors.js";
 import { uint16At } from "../bytes/view.js";
 import { pointsFromWpu } from "./units.js";
 //#region src/stream/table.ts
@@ -122,6 +123,34 @@ function readCellSpanning(data) {
 const COLOR_COMPONENT_MAX = 255;
 const RGBS_SIZE = 4;
 const FULL_SHADE = 255;
+const PERCENT_STEPS = [
+	[5, "percent5"],
+	[10, "percent10"],
+	[12, "percent12"],
+	[15, "percent15"],
+	[20, "percent20"],
+	[25, "percent25"],
+	[30, "percent30"],
+	[35, "percent35"],
+	[37, "percent37"],
+	[40, "percent40"],
+	[45, "percent45"],
+	[50, "percent50"],
+	[55, "percent55"],
+	[60, "percent60"],
+	[62, "percent62"],
+	[65, "percent65"],
+	[70, "percent70"],
+	[75, "percent75"],
+	[80, "percent80"],
+	[85, "percent85"],
+	[87, "percent87"],
+	[90, "percent90"],
+	[95, "percent95"]
+];
+function nearestPercentType(percent) {
+	return PERCENT_STEPS.reduce((best, step) => Math.abs(step[0] - percent) < Math.abs(best[0] - percent) ? step : best)[1];
+}
 function colorAt(data, offset) {
 	const r = data[offset];
 	const g = data[offset + 1];
@@ -137,9 +166,23 @@ function readCellFill(data) {
 	const background = colorAt(data, RGBS_SIZE);
 	if (background === void 0) return;
 	const backgroundShade = data[7];
+	if (backgroundShade === void 0 || backgroundShade === FULL_SHADE) return {
+		fill: {
+			kind: "solid",
+			color: background
+		},
+		blended: false
+	};
+	const foreground = colorAt(data, 0);
+	if (foreground === void 0) throw new WpdFormatError("Cell fill has a readable background colour but an unreadable foreground colour, which the RGBS pair's own contiguous layout should make impossible.");
 	return {
-		background,
-		blended: backgroundShade !== void 0 && backgroundShade !== FULL_SHADE
+		fill: {
+			kind: "pattern",
+			patternType: nearestPercentType(100 - backgroundShade / COLOR_COMPONENT_MAX * 100),
+			foregroundColor: foreground,
+			backgroundColor: background
+		},
+		blended: true
 	};
 }
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wpd-codec",
-  "version": "2.1.4",
+  "version": "3.0.0",
   "description": "Hand-written read-only WordPerfect 6.x-X6 (.wpd) reader over document-schema.js's ContentDocument",
   "type": "module",
   "repository": {
@@ -80,8 +80,8 @@
   "license": "MIT",
   "packageManager": "pnpm@11.6.0",
   "dependencies": {
-    "archive-codec": "^1.6.3",
-    "document-schema.js": "^6.2.2",
+    "archive-codec": "^1.6.4",
+    "document-schema.js": "^6.2.3",
     "zod": "^4.4.3"
   },
   "devDependencies": {