@quillmark/quillify 0.4.0 → 0.5.0

package/dist/assemble.js

@@ -1,11 +1,12 @@
 /** Every quill the library builds is a first version. */
 export const QUILL_VERSION = '0.1.0';
 /**
- * A string as a YAML double-quoted scalar. JSON writes it, from a well formed
- * string, and the characters the engine's reader refuses and JSON leaves raw
- * (U+007F to U+009F, U+FFFE and U+FFFF) are written as `\u` escapes.
+ * JSON as YAML the engine reads: the characters its reader refuses and JSON
+ * leaves raw (U+007F to U+009F, U+FFFE and U+FFFF) are written as `\u` escapes.
  */
-const q = (s) => JSON.stringify(s.toWellFormed()).replace(/[\u007f-\u009f\ufffe\uffff]/g, (c) => `\\u${c.charCodeAt(0).toString(16).padStart(4, '0')}`);
+const escaped = (json) => json.replace(/[\u007f-\u009f\ufffe\uffff]/g, (c) => `\\u${c.charCodeAt(0).toString(16).padStart(4, '0')}`);
+/** A string as a YAML double-quoted scalar, which JSON writes from a well formed string. */
+const q = (s) => escaped(JSON.stringify(s.toWellFormed()));
 /**
  * A `default:` says nobody need answer the field. A required field declares
  * none, a boolean apart: it defaults to false either way.
@@ -14,14 +15,13 @@ function fieldYaml(field) {
     const lines = [`    ${q(field.name)}:`];
     if (field.title !== undefined)
         lines.push(`      title: ${q(field.title)}`);
-    const ui = [];
     switch (field.type) {
         case 'string':
-            lines.push('      type: string');
+            lines.push('      type: text');
             if (!field.required)
                 lines.push('      default: ""');
             if (field.multiline)
-                ui.push('        multiline: true');
+                lines.push('      multiline: true');
             break;
         case 'boolean':
             lines.push('      type: boolean', '      default: false');
@@ -32,7 +32,7 @@ function fieldYaml(field) {
             // It refuses ";", ">" and "|" in a value too, so a dropdown with one is a text box.
             const values = (field.options ?? []).filter((option) => option !== '');
             if (values.length === 0 || values.some((value) => /[;>|]/.test(value)))
-                lines.push('      type: string');
+                lines.push('      type: text');
             else {
                 lines.push('      type: enum', '      values:');
                 for (const value of values)
@@ -43,14 +43,11 @@ function fieldYaml(field) {
             break;
         }
         case 'array':
-            lines.push('      type: array', '      items:', '        type: string');
+            lines.push('      type: array', '      items:', '        type: text');
             if (!field.required)
                 lines.push('      default: []');
-            ui.push('        multiline: true');
             break;
     }
-    if (ui.length > 0)
-        lines.push('      ui:', ...ui);
     lines.push(`      description: ${q(field.description)}`);
     return lines;
 }
@@ -131,7 +128,7 @@ export function assembleQuill(form, inventory, formPdf) {
     const tree = new Map([
         ['Quill.yaml', encoder.encode(quillYaml(form, bound))],
         ['form.pdf', formPdf],
-        ['form.json', encoder.encode(JSON.stringify(formJson, null, 2) + '\n')]
+        ['form.yaml', encoder.encode(escaped(JSON.stringify(formJson, null, 2)) + '\n')]
     ]);
     const example = exampleMarkdown(form, bound);
     if (example)

package/dist/xfa-widgets.d.ts

@@ -8,7 +8,7 @@ export interface XfaWidget {
     name: string;
     kind: XfaKind;
     page: number;
-    /** Points, top-left origin, page-relative: the rect `form.json` wants. */
+    /** Points, top-left origin, page-relative: the rect `form.yaml` wants. */
     x: number;
     y: number;
     w: number;

package/dist/xfa.js

@@ -54,9 +54,11 @@ export async function xfaToAcroForm(bytes, signal) {
                     construct: 'image',
                     detail: 'pixels'
                 });
-            for (const widget of harvestWidgets(laid, number))
+            const harvested = harvestWidgets(laid, number);
+            for (const widget of harvested)
                 widgets.push(widget);
-            await paint(out.addPage([list.width, list.height]), number, list, async (name) => {
+            const shown = whiten(list, harvested);
+            await paint(out.addPage([list.width, list.height]), number, shown, async (name) => {
                 let font = fonts.get(name);
                 if (!font)
                     fonts.set(name, (font = await out.embedFont(name)));
@@ -71,6 +73,28 @@ export async function xfaToAcroForm(bytes, signal) {
         await opened?.close();
     }
 }
+/**
+ * The engine fills every field in black, whatever colour the form gives its
+ * text. A field whose middle lies on a fill that black reads on at under 4.5:1,
+ * WCAG's floor for text, gets a white box drawn just over that fill.
+ */
+function whiten(list, widgets) {
+    const drawn = [...list.drawn];
+    const filled = (item) => 'edges' in item && item.fill !== null;
+    for (const { x, y, w, h } of widgets) {
+        const [u, v] = [x + w / 2, y + h / 2];
+        const at = drawn.findLastIndex((item) => filled(item) && item.x <= u && u <= item.x + item.w && item.y <= v && v <= item.y + item.h);
+        const under = drawn[at];
+        if (at >= 0 && filled(under) && (luminance(under.fill) + 0.05) / 0.05 < 4.5)
+            drawn.splice(at + 1, 0, { x, y, w, h, fill: [1, 1, 1], edges: [null, null, null, null] });
+    }
+    return { ...list, drawn };
+}
+/** The relative luminance WCAG gives a colour in sRGB. */
+function luminance(colour) {
+    const [r, g, b] = colour.map((c) => (c <= 0.04045 ? c / 12.92 : ((c + 0.055) / 1.055) ** 2.4));
+    return 0.2126 * r + 0.7152 * g + 0.0722 * b;
+}
 /** PDF's origin is bottom-left; every primitive arrives top-left. */
 async function paint(page, pageNumber, list, font) {
     const H = list.height;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@quillmark/quillify",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"description": "Turn a published PDF form (AcroForm or XFA) into a Quillmark quill, in the browser.",
 	"type": "module",
 	"license": "Apache-2.0",
@@ -48,7 +48,7 @@
 	},
 	"devDependencies": {
 		"@neslinesli93/qpdf-wasm": "0.3.0",
-		"@quillmark/wasm": "0.125.0",
+		"@quillmark/wasm": "0.126.0",
 		"@types/node": "24.19.0",
 		"@vitest/browser-playwright": "5.0.2",
 		"fast-check": "4.10.2",
@@ -63,7 +63,7 @@
 		"pdfjs-dist": "6.4.299"
 	},
 	"peerDependencies": {
-		"@quillmark/wasm": ">=0.124.0"
+		"@quillmark/wasm": ">=0.126.0"
 	},
 	"publishConfig": {
 		"access": "public"