@hexpro/qr-code-studio 0.0.0-stage → 0.1.1

package/dist/conformance/frame.js

@@ -0,0 +1,134 @@
+/**
+ * Conformance for frames.
+ *
+ * A frame decorates the space round the quiet zone and must never draw in
+ * it: the quiet zone is how a reader finds where the code stops, and ink in
+ * it is the commonest way a styled code fails. Each frame is laid out round
+ * the smallest and largest QR codes and round Micro QR and rMQR sizes, at its
+ * defaults and the ends of its ranges, and the quiet zone box is rasterised
+ * on its own: any coverage at all inside it is a violation. Its caption box
+ * must sit inside the artwork and outside the quiet zone, and a frame that
+ * takes a caption must reserve one.
+ */
+import { PathBuilder } from '../geometry/path.js';
+import { rasterise } from '../render/raster.js';
+import { sampleParams } from './sample.js';
+/** QR versions 1 and 40, Micro QR M1, and the shortest and longest rMQR. */
+export const FRAME_SIZES = Object.freeze([
+    { width: 21, height: 21, quietZone: 4 },
+    { width: 177, height: 177, quietZone: 4 },
+    { width: 11, height: 11, quietZone: 2 },
+    { width: 43, height: 7, quietZone: 2 },
+    { width: 139, height: 17, quietZone: 2 },
+]);
+/** The longest side of the quiet zone box, in pixels, when it is rasterised on its own. */
+const QUIET_PIXELS = 256;
+function shiftPath(path, dx, dy, scale) {
+    return new PathBuilder()
+        .transform([scale, 0, 0, scale, dx * scale, dy * scale])
+        .append(path)
+        .build();
+}
+/** A node moved by (dx, dy) and scaled, so the quiet zone box lands on the raster. */
+function shift(node, dx, dy, scale) {
+    if (node.kind === 'path')
+        return { ...node, path: shiftPath(node.path, dx, dy, scale) };
+    if (node.kind === 'image') {
+        return {
+            ...node,
+            x: (node.x + dx) * scale,
+            y: (node.y + dy) * scale,
+            width: node.width * scale,
+            height: node.height * scale,
+            ...(node.clip === undefined ? {} : { clip: shiftPath(node.clip, dx, dy, scale) }),
+        };
+    }
+    return {
+        ...node,
+        children: node.children.map((child) => shift(child, dx, dy, scale)),
+        ...(node.clip === undefined ? {} : { clip: shiftPath(node.clip, dx, dy, scale) }),
+    };
+}
+/** Paths as plain arrays, so two layouts compare by value. */
+function fingerprint(layout) {
+    return JSON.stringify(layout, (_key, value) => ArrayBuffer.isView(value) ? Array.from(value) : value);
+}
+export function checkFrame(frame, options = {}) {
+    const violations = [];
+    const black = { kind: 'solid', colour: { r: 0, g: 0, b: 0, a: 1 } };
+    for (const size of options.sizes ?? FRAME_SIZES) {
+        for (const params of sampleParams(frame.params, options.seed ?? 1, options.mixtures ?? 3)) {
+            const where = `${size.width} by ${size.height}, quiet zone ${size.quietZone}, params ${JSON.stringify(params)}`;
+            const ctx = {
+                symbolSize: { width: size.width, height: size.height },
+                quietZone: size.quietZone,
+                params,
+                paint: black,
+            };
+            const layout = frame.layout(ctx);
+            if (fingerprint(layout) !== fingerprint(frame.layout(ctx))) {
+                violations.push({
+                    entry: frame.id,
+                    rule: 'deterministic',
+                    detail: `${where}: two layouts differ`,
+                });
+            }
+            const qw = size.width + 2 * size.quietZone;
+            const qh = size.height + 2 * size.quietZone;
+            const { x, y } = layout.symbol;
+            if (x < 0 || y < 0 || x + qw > layout.width + 1e-9 || y + qh > layout.height + 1e-9) {
+                violations.push({
+                    entry: frame.id,
+                    rule: 'layout',
+                    detail: `${where}: the quiet zone box is not inside the artwork`,
+                });
+                continue;
+            }
+            const scale = QUIET_PIXELS / Math.max(qw, qh);
+            const image = rasterise({
+                width: qw * scale,
+                height: qh * scale,
+                background: null,
+                layers: [...layout.nodes, ...(layout.over ?? [])].map((node) => shift(node, -x, -y, scale)),
+            }, { width: Math.round(qw * scale), height: Math.round(qh * scale) });
+            let inked = 0;
+            for (let i = 3; i < image.data.length; i += 4)
+                if (image.data[i] !== 0)
+                    inked += 1;
+            if (inked > 0) {
+                violations.push({
+                    entry: frame.id,
+                    rule: 'quiet-zone',
+                    detail: `${where}: ${inked} pixels of the quiet zone are inked`,
+                });
+            }
+            const box = layout.textBox;
+            if (box === null) {
+                if (frame.text !== null) {
+                    violations.push({
+                        entry: frame.id,
+                        rule: 'text-box',
+                        detail: `${where}: a captioned frame reserves no box`,
+                    });
+                }
+                continue;
+            }
+            const inside = box.width >= 0 &&
+                box.height >= 0 &&
+                box.x >= -1e-9 &&
+                box.y >= -1e-9 &&
+                box.x + box.width <= layout.width + 1e-9 &&
+                box.y + box.height <= layout.height + 1e-9;
+            const overlaps = box.x < x + qw && box.x + box.width > x && box.y < y + qh && box.y + box.height > y;
+            if (!inside || overlaps) {
+                violations.push({
+                    entry: frame.id,
+                    rule: 'text-box',
+                    detail: `${where}: the caption box ${overlaps ? 'overlaps the quiet zone' : 'leaves the artwork'}`,
+                });
+            }
+        }
+    }
+    return violations;
+}
+//# sourceMappingURL=frame.js.map

package/dist/conformance/frame.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frame.js","sourceRoot":"","sources":["../../src/conformance/frame.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAS3C,4EAA4E;AAC5E,MAAM,CAAC,MAAM,WAAW,GAAyB,MAAM,CAAC,MAAM,CAAC;IAC9D,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE;IACvC,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,EAAE;IACzC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE;IACvC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE;IACtC,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,EAAE;CACxC,CAAC,CAAC;AAEH,2FAA2F;AAC3F,MAAM,YAAY,GAAG,GAAG,CAAC;AAQzB,SAAS,SAAS,CAAC,IAAU,EAAE,EAAU,EAAE,EAAU,EAAE,KAAa;IACnE,OAAO,IAAI,WAAW,EAAE;SACtB,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,GAAG,KAAK,CAAC,CAAC;SACvD,MAAM,CAAC,IAAI,CAAC;SACZ,KAAK,EAAE,CAAC;AACX,CAAC;AAED,sFAAsF;AACtF,SAAS,KAAK,CAAC,IAAe,EAAE,EAAU,EAAE,EAAU,EAAE,KAAa;IACpE,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM;QAAE,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC;IACxF,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO;YACN,GAAG,IAAI;YACP,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,KAAK;YACxB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,KAAK;YACxB,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,KAAK;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,KAAK;YAC3B,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC;SACjF,CAAC;IACH,CAAC;IACD,OAAO;QACN,GAAG,IAAI;QACP,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;QACnE,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC;KACjF,CAAC;AACH,CAAC;AAED,8DAA8D;AAC9D,SAAS,WAAW,CAAC,MAAmB;IACvC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,KAAc,EAAE,EAAE,CACtD,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAmB,CAAC,CAAC,CAAC,CAAC,KAAK,CACnE,CAAC;AACH,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAiB,EAAE,UAA6B,EAAE;IAC5E,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,OAAgB,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;IAC7E,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,IAAI,WAAW,EAAE,CAAC;QACjD,KAAK,MAAM,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,EAAE,CAAC;YAC3F,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,KAAK,OAAO,IAAI,CAAC,MAAM,gBAAgB,IAAI,CAAC,SAAS,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAChH,MAAM,GAAG,GAAG;gBACX,UAAU,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;gBACtD,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,MAAM;gBACN,KAAK,EAAE,KAAK;aACZ,CAAC;YACF,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC5D,UAAU,CAAC,IAAI,CAAC;oBACf,KAAK,EAAE,KAAK,CAAC,EAAE;oBACf,IAAI,EAAE,eAAe;oBACrB,MAAM,EAAE,GAAG,KAAK,sBAAsB;iBACtC,CAAC,CAAC;YACJ,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;YAC3C,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;YAC5C,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC;YAC/B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;gBACrF,UAAU,CAAC,IAAI,CAAC;oBACf,KAAK,EAAE,KAAK,CAAC,EAAE;oBACf,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,GAAG,KAAK,gDAAgD;iBAChE,CAAC,CAAC;gBACH,SAAS;YACV,CAAC;YACD,MAAM,KAAK,GAAG,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YAC9C,MAAM,KAAK,GAAG,SAAS,CACtB;gBACC,KAAK,EAAE,EAAE,GAAG,KAAK;gBACjB,MAAM,EAAE,EAAE,GAAG,KAAK;gBAClB,UAAU,EAAE,IAAI;gBAChB,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC9D,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAC1B;aACD,EACD,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,CACjE,CAAC;YACF,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;gBAAE,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;oBAAE,KAAK,IAAI,CAAC,CAAC;YACnF,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACf,UAAU,CAAC,IAAI,CAAC;oBACf,KAAK,EAAE,KAAK,CAAC,EAAE;oBACf,IAAI,EAAE,YAAY;oBAClB,MAAM,EAAE,GAAG,KAAK,KAAK,KAAK,qCAAqC;iBAC/D,CAAC,CAAC;YACJ,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC;YAC3B,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBAClB,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBACzB,UAAU,CAAC,IAAI,CAAC;wBACf,KAAK,EAAE,KAAK,CAAC,EAAE;wBACf,IAAI,EAAE,UAAU;wBAChB,MAAM,EAAE,GAAG,KAAK,qCAAqC;qBACrD,CAAC,CAAC;gBACJ,CAAC;gBACD,SAAS;YACV,CAAC;YACD,MAAM,MAAM,GACX,GAAG,CAAC,KAAK,IAAI,CAAC;gBACd,GAAG,CAAC,MAAM,IAAI,CAAC;gBACf,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI;gBACd,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI;gBACd,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,GAAG,IAAI;gBACxC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;YAC5C,MAAM,QAAQ,GACb,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;YACrF,IAAI,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC;gBACzB,UAAU,CAAC,IAAI,CAAC;oBACf,KAAK,EAAE,KAAK,CAAC,EAAE;oBACf,IAAI,EAAE,UAAU;oBAChB,MAAM,EAAE,GAAG,KAAK,qBAAqB,QAAQ,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,oBAAoB,EAAE;iBAClG,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,UAAU,CAAC;AACnB,CAAC"}

package/dist/conformance/index.d.ts

@@ -0,0 +1,15 @@
+export type { Violation } from './types.js';
+export { sampleParams } from './sample.js';
+export { CENTRE_CROSS_ARM, CENTRE_CROSS_MIN, LIGHT_DISC_RADIUS, MODULE_PIXELS, checkModuleShape, } from './module-shape.js';
+export type { ModuleShapeCheckOptions } from './module-shape.js';
+export { checkRegionShape } from './region-shape.js';
+export type { RegionShapeCheckOptions } from './region-shape.js';
+export { FAMILY_MODULES, checkRegionCaptures, familyPairs } from './region-captures.js';
+export type { RegionCaptureCheck, RegionCaptureOptions } from './region-captures.js';
+export { FRAME_SIZES, checkFrame } from './frame.js';
+export type { FrameCheckOptions, FrameSize } from './frame.js';
+export { MIN_CONTRAST, checkPreset, contrast, darkInks, emptySymbol, luminance, paintInks, } from './preset.js';
+export type { PresetVerifier } from './preset.js';
+export { checkPayloadType } from './payload-type.js';
+export type { PayloadTypeLike, PayloadVectorLike } from './payload-type.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/conformance/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/conformance/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EACN,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,GAChB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,YAAY,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxF,YAAY,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACrD,YAAY,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC/D,OAAO,EACN,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,SAAS,EACT,SAAS,GACT,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,YAAY,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/conformance/index.js

@@ -0,0 +1,8 @@
+export { sampleParams } from './sample.js';
+export { CENTRE_CROSS_ARM, CENTRE_CROSS_MIN, LIGHT_DISC_RADIUS, MODULE_PIXELS, checkModuleShape, } from './module-shape.js';
+export { checkRegionShape } from './region-shape.js';
+export { FAMILY_MODULES, checkRegionCaptures, familyPairs } from './region-captures.js';
+export { FRAME_SIZES, checkFrame } from './frame.js';
+export { MIN_CONTRAST, checkPreset, contrast, darkInks, emptySymbol, luminance, paintInks, } from './preset.js';
+export { checkPayloadType } from './payload-type.js';
+//# sourceMappingURL=index.js.map

package/dist/conformance/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/conformance/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EACN,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,GAChB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAExF,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAErD,OAAO,EACN,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,SAAS,EACT,SAAS,GACT,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/conformance/module-shape.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Conformance for module shapes.
+ *
+ * A reader decides each module by sampling near its centre, and a module
+ * shape that leaves its centre light, or ink that lands in a light
+ * neighbour, is a wrong bit before any camera is involved. So every shape is
+ * drawn at 16 pixels a module for all 256 neighbour masks, at each sampled
+ * set of parameters, and held to four rules:
+ *
+ * - centre-cross: the five points at the centre and 0.2 either side of it
+ *   on both axes are inked at 0.98 or more (every pixel touching each point);
+ * - outside-cell: nothing is inked outside the cell, except, for a shape that
+ *   connects, in an edge neighbour that is dark;
+ * - light-neighbour: nothing reaches within 0.3 of a light neighbour's centre;
+ * - deterministic: the same mask, parameters and seed draw the same path.
+ */
+import type { ModuleShape } from '../design/types.js';
+import type { Violation } from './types.js';
+/** Pixels a module the shape is drawn at. */
+export declare const MODULE_PIXELS = 16;
+/** The share of each centre cross point that must be inked. */
+export declare const CENTRE_CROSS_MIN = 0.98;
+/** How far the cross points sit from the centre, in modules. */
+export declare const CENTRE_CROSS_ARM = 0.2;
+/** The radius round a light neighbour's centre that nothing may enter. */
+export declare const LIGHT_DISC_RADIUS = 0.3;
+export interface ModuleShapeCheckOptions {
+    /** Seeds the parameter mixtures and each module's stream. Default 1. */
+    readonly seed?: number;
+    /** How many seeded parameter mixtures to draw beside the defaults and extremes. Default 3. */
+    readonly mixtures?: number;
+}
+/** Every rule the shape breaks, at most one violation per rule and parameter set. */
+export declare function checkModuleShape(shape: ModuleShape, options?: ModuleShapeCheckOptions): Violation[];
+//# sourceMappingURL=module-shape.d.ts.map

package/dist/conformance/module-shape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-shape.d.ts","sourceRoot":"","sources":["../../src/conformance/module-shape.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAOH,OAAO,KAAK,EAAE,WAAW,EAAkB,MAAM,oBAAoB,CAAC;AAGtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,6CAA6C;AAC7C,eAAO,MAAM,aAAa,KAAK,CAAC;AAChC,+DAA+D;AAC/D,eAAO,MAAM,gBAAgB,OAAO,CAAC;AACrC,gEAAgE;AAChE,eAAO,MAAM,gBAAgB,MAAM,CAAC;AACpC,0EAA0E;AAC1E,eAAO,MAAM,iBAAiB,MAAM,CAAC;AAErC,MAAM,WAAW,uBAAuB;IACvC,wEAAwE;IACxE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,8FAA8F;IAC9F,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC3B;AAmBD,qFAAqF;AACrF,wBAAgB,gBAAgB,CAC/B,KAAK,EAAE,WAAW,EAClB,OAAO,GAAE,uBAA4B,GACnC,SAAS,EAAE,CAiGb"}

package/dist/conformance/module-shape.js

@@ -0,0 +1,139 @@
+/**
+ * Conformance for module shapes.
+ *
+ * A reader decides each module by sampling near its centre, and a module
+ * shape that leaves its centre light, or ink that lands in a light
+ * neighbour, is a wrong bit before any camera is involved. So every shape is
+ * drawn at 16 pixels a module for all 256 neighbour masks, at each sampled
+ * set of parameters, and held to four rules:
+ *
+ * - centre-cross: the five points at the centre and 0.2 either side of it
+ *   on both axes are inked at 0.98 or more (every pixel touching each point);
+ * - outside-cell: nothing is inked outside the cell, except, for a shape that
+ *   connects, in an edge neighbour that is dark;
+ * - light-neighbour: nothing reaches within 0.3 of a light neighbour's centre;
+ * - deterministic: the same mask, parameters and seed draw the same path.
+ */
+import { createPrng } from '../core/prng.js';
+import { bounds } from '../geometry/measure.js';
+import { PathBuilder } from '../geometry/path.js';
+import { NEIGHBOUR_OFFSETS } from '../design/neighbours.js';
+import { rasterise } from '../render/raster.js';
+import { sampleParams } from './sample.js';
+/** Pixels a module the shape is drawn at. */
+export const MODULE_PIXELS = 16;
+/** The share of each centre cross point that must be inked. */
+export const CENTRE_CROSS_MIN = 0.98;
+/** How far the cross points sit from the centre, in modules. */
+export const CENTRE_CROSS_ARM = 0.2;
+/** The radius round a light neighbour's centre that nothing may enter. */
+export const LIGHT_DISC_RADIUS = 0.3;
+function draw(shape, neighbours, params, seed) {
+    const out = new PathBuilder();
+    shape.path({ neighbours, params, prng: createPrng(seed).fork(neighbours) }, out);
+    return out.build();
+}
+function samePath(a, b) {
+    if (a.commands.length !== b.commands.length || a.points.length !== b.points.length)
+        return false;
+    for (let i = 0; i < a.commands.length; i += 1)
+        if (a.commands[i] !== b.commands[i])
+            return false;
+    for (let i = 0; i < a.points.length; i += 1)
+        if (a.points[i] !== b.points[i])
+            return false;
+    return true;
+}
+function hex(mask) {
+    return `0x${mask.toString(16).padStart(2, '0')}`;
+}
+/** Every rule the shape breaks, at most one violation per rule and parameter set. */
+export function checkModuleShape(shape, options = {}) {
+    const seed = options.seed ?? 1;
+    const violations = [];
+    const size = 3 * MODULE_PIXELS;
+    for (const params of sampleParams(shape.params, seed, options.mixtures ?? 3)) {
+        const where = `params ${JSON.stringify(params)}`;
+        const broken = new Set();
+        const report = (rule, detail) => {
+            if (broken.has(rule))
+                return;
+            broken.add(rule);
+            violations.push({ entry: shape.id, rule, detail: `${where}, ${detail}` });
+        };
+        for (let mask = 0; mask < 256; mask += 1) {
+            const path = draw(shape, mask, params, seed);
+            if (!samePath(path, draw(shape, mask, params, seed))) {
+                report('deterministic', `neighbours ${hex(mask)}: two draws differ`);
+            }
+            const box = bounds(path);
+            if (box === null) {
+                report('centre-cross', `neighbours ${hex(mask)}: nothing is drawn`);
+                continue;
+            }
+            // Beyond the three by three window the raster below cannot see.
+            if (box.x < -1 || box.y < -1 || box.x + box.width > 2 || box.y + box.height > 2) {
+                report('outside-cell', `neighbours ${hex(mask)}: the shape reaches past its neighbours`);
+            }
+            const placed = new PathBuilder().transform([1, 0, 0, 1, 1, 1]).append(path).build();
+            const image = rasterise({
+                width: 3,
+                height: 3,
+                background: null,
+                layers: [
+                    {
+                        kind: 'path',
+                        path: placed,
+                        paint: { kind: 'solid', colour: { r: 0, g: 0, b: 0, a: 1 } },
+                    },
+                ],
+            }, { width: size });
+            const alpha = (x, y) => image.data[(y * size + x) * 4 + 3] / 255;
+            for (const [dx, dy] of [
+                [0, 0],
+                [-CENTRE_CROSS_ARM, 0],
+                [CENTRE_CROSS_ARM, 0],
+                [0, -CENTRE_CROSS_ARM],
+                [0, CENTRE_CROSS_ARM],
+            ]) {
+                const px = (1.5 + dx) * MODULE_PIXELS;
+                const py = (1.5 + dy) * MODULE_PIXELS;
+                // Every pixel whose closed square holds the point.
+                const xs = Number.isInteger(px) ? [px - 1, px] : [Math.floor(px)];
+                const ys = Number.isInteger(py) ? [py - 1, py] : [Math.floor(py)];
+                let least = 1;
+                for (const y of ys)
+                    for (const x of xs)
+                        least = Math.min(least, alpha(x, y));
+                if (least < CENTRE_CROSS_MIN) {
+                    report('centre-cross', `neighbours ${hex(mask)}: the point ${0.5 + dx}, ${0.5 + dy} is inked ${least.toFixed(3)}`);
+                }
+            }
+            for (let y = 0; y < size; y += 1) {
+                for (let x = 0; x < size; x += 1) {
+                    if (alpha(x, y) === 0)
+                        continue;
+                    const cx = Math.floor(x / MODULE_PIXELS) - 1;
+                    const cy = Math.floor(y / MODULE_PIXELS) - 1;
+                    if (cx === 0 && cy === 0)
+                        continue;
+                    const bit = NEIGHBOUR_OFFSETS.findIndex(([ox, oy]) => ox === cx && oy === cy);
+                    const dark = (mask & (1 << bit)) !== 0;
+                    const edge = cx === 0 || cy === 0;
+                    if (!(shape.connects && edge && dark)) {
+                        report('outside-cell', `neighbours ${hex(mask)}: ink at ${((x + 0.5) / MODULE_PIXELS - 1).toFixed(3)}, ${((y + 0.5) / MODULE_PIXELS - 1).toFixed(3)} in the cell at ${cx}, ${cy}`);
+                    }
+                    if (!dark) {
+                        const ux = (x + 0.5) / MODULE_PIXELS - (1.5 + cx);
+                        const uy = (y + 0.5) / MODULE_PIXELS - (1.5 + cy);
+                        if (ux * ux + uy * uy < LIGHT_DISC_RADIUS * LIGHT_DISC_RADIUS) {
+                            report('light-neighbour', `neighbours ${hex(mask)}: ink within ${LIGHT_DISC_RADIUS} of the light neighbour at ${cx}, ${cy}`);
+                        }
+                    }
+                }
+            }
+        }
+    }
+    return violations;
+}
+//# sourceMappingURL=module-shape.js.map

package/dist/conformance/module-shape.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-shape.js","sourceRoot":"","sources":["../../src/conformance/module-shape.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE5D,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,6CAA6C;AAC7C,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,CAAC;AAChC,+DAA+D;AAC/D,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AACrC,gEAAgE;AAChE,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AACpC,0EAA0E;AAC1E,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AASrC,SAAS,IAAI,CAAC,KAAkB,EAAE,UAAkB,EAAE,MAAsB,EAAE,IAAY;IACzF,MAAM,GAAG,GAAG,IAAI,WAAW,EAAE,CAAC;IAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACjF,OAAO,GAAG,CAAC,KAAK,EAAE,CAAC;AACpB,CAAC;AAED,SAAS,QAAQ,CAAC,CAAO,EAAE,CAAO;IACjC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACjG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;QAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;IACjG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;QAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;IAC3F,OAAO,IAAI,CAAC;AACb,CAAC;AAED,SAAS,GAAG,CAAC,IAAY;IACxB,OAAO,KAAK,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AAClD,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,gBAAgB,CAC/B,KAAkB,EAClB,UAAmC,EAAE;IAErC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC;IAC/B,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,MAAM,IAAI,GAAG,CAAC,GAAG,aAAa,CAAC;IAC/B,KAAK,MAAM,MAAM,IAAI,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,EAAE,CAAC;QAC9E,MAAM,KAAK,GAAG,UAAU,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QACjD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;QACjC,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,MAAc,EAAQ,EAAE;YACrD,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,OAAO;YAC7B,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACjB,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,KAAK,MAAM,EAAE,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC;QACF,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,GAAG,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;gBACtD,MAAM,CAAC,eAAe,EAAE,cAAc,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACtE,CAAC;YACD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBAClB,MAAM,CAAC,cAAc,EAAE,cAAc,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;gBACpE,SAAS;YACV,CAAC;YACD,gEAAgE;YAChE,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACjF,MAAM,CAAC,cAAc,EAAE,cAAc,GAAG,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;YAC1F,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;YACpF,MAAM,KAAK,GAAG,SAAS,CACtB;gBACC,KAAK,EAAE,CAAC;gBACR,MAAM,EAAE,CAAC;gBACT,UAAU,EAAE,IAAI;gBAChB,MAAM,EAAE;oBACP;wBACC,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,MAAM;wBACZ,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;qBAC5D;iBACD;aACD,EACD,EAAE,KAAK,EAAE,IAAI,EAAE,CACf,CAAC;YACF,MAAM,KAAK,GAAG,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE,CAC7C,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAY,GAAG,GAAG,CAAC;YAEtD,KAAK,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI;gBACtB,CAAC,CAAC,EAAE,CAAC,CAAC;gBACN,CAAC,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBACtB,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBACrB,CAAC,CAAC,EAAE,CAAC,gBAAgB,CAAC;gBACtB,CAAC,CAAC,EAAE,gBAAgB,CAAC;aACZ,EAAE,CAAC;gBACZ,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,aAAa,CAAC;gBACtC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,aAAa,CAAC;gBACtC,mDAAmD;gBACnD,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBAClE,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBAClE,IAAI,KAAK,GAAG,CAAC,CAAC;gBACd,KAAK,MAAM,CAAC,IAAI,EAAE;oBAAE,KAAK,MAAM,CAAC,IAAI,EAAE;wBAAE,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC7E,IAAI,KAAK,GAAG,gBAAgB,EAAE,CAAC;oBAC9B,MAAM,CACL,cAAc,EACd,cAAc,GAAG,CAAC,IAAI,CAAC,eAAe,GAAG,GAAG,EAAE,KAAK,GAAG,GAAG,EAAE,aAAa,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAC1F,CAAC;gBACH,CAAC;YACF,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;oBAClC,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC;wBAAE,SAAS;oBAChC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;oBAC7C,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;oBAC7C,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC;wBAAE,SAAS;oBACnC,MAAM,GAAG,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;oBAC9E,MAAM,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;oBACvC,MAAM,IAAI,GAAG,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBAClC,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;wBACvC,MAAM,CACL,cAAc,EACd,cAAc,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,aAAa,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,aAAa,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,EAAE,KAAK,EAAE,EAAE,CAC1J,CAAC;oBACH,CAAC;oBACD,IAAI,CAAC,IAAI,EAAE,CAAC;wBACX,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,aAAa,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;wBAClD,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,aAAa,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;wBAClD,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,iBAAiB,GAAG,iBAAiB,EAAE,CAAC;4BAC/D,MAAM,CACL,iBAAiB,EACjB,cAAc,GAAG,CAAC,IAAI,CAAC,gBAAgB,iBAAiB,8BAA8B,EAAE,KAAK,EAAE,EAAE,CACjG,CAAC;wBACH,CAAC;oBACF,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IACD,OAAO,UAAU,CAAC;AACnB,CAAC"}

package/dist/conformance/payload-type.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Conformance for content types: each specification vector reads as its
+ * value, and a value that validates is written and read back unchanged.
+ *
+ * The vectors come from the argument, or else from the type itself. The
+ * built-in types carry none, because they would ship to every visitor as
+ * test data; theirs are in `./payload/vectors` and the gate passes them in.
+ * A type from somewhere else may still carry its own, and they are run when
+ * present. A type with no vectors at all has nothing to check here.
+ *
+ * Specifications print examples that fail their own checks (BIP 21's
+ * address fails its base58check checksum), and a reader must still read
+ * them. So a vector whose value does not validate is held to reading, and
+ * to `build` refusing it, and no more. Which vectors those are is for the
+ * caller to pin, as the built-in gate does.
+ *
+ * Conformance may not import payload, so the parts of a content type this
+ * uses are repeated here structurally, as design repeats PayloadConstraints.
+ * A `PayloadType` is one of these without a cast.
+ *
+ * Details name a vector by its position and never quote its text or value:
+ * a third party's vectors are theirs to keep out of a log.
+ */
+import type { Issue } from '../core/issue.js';
+import type { Violation } from './types.js';
+/** A published example: the text as printed, the value it holds, and where it was printed. */
+export interface PayloadVectorLike<V> {
+    readonly text: string;
+    readonly value: V;
+    readonly source: string;
+}
+/** The parts of payload's `PayloadType` this check uses. */
+export interface PayloadTypeLike<V> {
+    readonly id: string;
+    readonly generate?: boolean;
+    validate(value: V): readonly Issue[];
+    build(value: V): {
+        readonly text: string;
+    };
+    parse(text: string): V;
+    readonly vectors?: readonly PayloadVectorLike<V>[];
+}
+/**
+ * Runs `vectors`, or the type's own when that is left out, and returns one
+ * violation per rule a vector breaks. An empty list is a pass.
+ */
+export declare function checkPayloadType<V>(type: PayloadTypeLike<V>, vectors?: readonly PayloadVectorLike<V>[]): Violation[];
+//# sourceMappingURL=payload-type.d.ts.map

package/dist/conformance/payload-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload-type.d.ts","sourceRoot":"","sources":["../../src/conformance/payload-type.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,8FAA8F;AAC9F,MAAM,WAAW,iBAAiB,CAAC,CAAC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACxB;AAED,4DAA4D;AAC5D,MAAM,WAAW,eAAe,CAAC,CAAC;IACjC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,SAAS,KAAK,EAAE,CAAC;IACrC,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;CACnD;AAqCD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EACjC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EACxB,OAAO,CAAC,EAAE,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAAE,GACvC,SAAS,EAAE,CAiDb"}

package/dist/conformance/payload-type.js

@@ -0,0 +1,113 @@
+/**
+ * Conformance for content types: each specification vector reads as its
+ * value, and a value that validates is written and read back unchanged.
+ *
+ * The vectors come from the argument, or else from the type itself. The
+ * built-in types carry none, because they would ship to every visitor as
+ * test data; theirs are in `./payload/vectors` and the gate passes them in.
+ * A type from somewhere else may still carry its own, and they are run when
+ * present. A type with no vectors at all has nothing to check here.
+ *
+ * Specifications print examples that fail their own checks (BIP 21's
+ * address fails its base58check checksum), and a reader must still read
+ * them. So a vector whose value does not validate is held to reading, and
+ * to `build` refusing it, and no more. Which vectors those are is for the
+ * caller to pin, as the built-in gate does.
+ *
+ * Conformance may not import payload, so the parts of a content type this
+ * uses are repeated here structurally, as design repeats PayloadConstraints.
+ * A `PayloadType` is one of these without a cast.
+ *
+ * Details name a vector by its position and never quote its text or value:
+ * a third party's vectors are theirs to keep out of a log.
+ */
+import { hasErrors } from '../core/issue.js';
+/**
+ * Equal as the test suite's `toEqual` compares: a key holding `undefined` is
+ * the same as no key, and numbers compare with Object.is, so 0 is not -0.
+ */
+function same(a, b) {
+    if (Object.is(a, b))
+        return true;
+    if (typeof a !== 'object' || typeof b !== 'object' || a === null || b === null)
+        return false;
+    if (Array.isArray(a) !== Array.isArray(b))
+        return false;
+    if (Array.isArray(a) && Array.isArray(b)) {
+        return a.length === b.length && a.every((item, i) => same(item, b[i]));
+    }
+    const left = a;
+    const right = b;
+    const keys = new Set([...Object.keys(left), ...Object.keys(right)]);
+    return [...keys].every((key) => same(left[key], right[key]));
+}
+/** The field keys two values disagree on, which says where to look without saying what is there. */
+function differing(a, b) {
+    if (typeof a !== 'object' || typeof b !== 'object' || a === null || b === null) {
+        return 'not a record';
+    }
+    const left = a;
+    const right = b;
+    const keys = [...new Set([...Object.keys(left), ...Object.keys(right)])];
+    return `fields ${keys.filter((key) => !same(left[key], right[key])).join(', ')}`;
+}
+/** What a thrown value was, by class and code, without its message, which may quote the text. */
+function thrown(error) {
+    if (!(error instanceof Error))
+        return 'a non-error value';
+    const code = error.code;
+    return typeof code === 'string' ? `${error.name} ${code}` : error.name;
+}
+/**
+ * Runs `vectors`, or the type's own when that is left out, and returns one
+ * violation per rule a vector breaks. An empty list is a pass.
+ */
+export function checkPayloadType(type, vectors) {
+    const violations = [];
+    const fail = (rule, detail) => {
+        violations.push({ entry: type.id, rule, detail });
+    };
+    (vectors ?? type.vectors ?? []).forEach((vector, index) => {
+        const where = `vector ${index}`;
+        if (vector.source.trim() === '')
+            fail('vector-source', `${where} cites no source`);
+        try {
+            const read = type.parse(vector.text);
+            if (!same(read, vector.value)) {
+                fail('vector-parse', `${where} reads as a different value (${differing(read, vector.value)})`);
+            }
+        }
+        catch (error) {
+            fail('vector-parse', `${where} does not read: parse threw ${thrown(error)}`);
+        }
+        const invalid = hasErrors(type.validate(vector.value));
+        if (invalid || type.generate === false) {
+            // A value with error issues is a caller's mistake to `build`, and a
+            // type that cannot be made has nothing honest to write: both throw
+            // TypeError rather than write a code that scans and then fails.
+            let outcome = 'returned a text';
+            try {
+                type.build(vector.value);
+            }
+            catch (error) {
+                outcome = error instanceof TypeError ? '' : `threw ${thrown(error)}`;
+            }
+            if (outcome !== '') {
+                const why = invalid ? 'a value with error issues' : 'a type that cannot be made';
+                fail('vector-build', `${where}: build ${outcome} for ${why}, not a TypeError`);
+            }
+            return;
+        }
+        try {
+            const again = type.parse(type.build(vector.value).text);
+            if (!same(again, vector.value)) {
+                fail('vector-round-trip', `${where}: what build writes reads back differently (${differing(again, vector.value)})`);
+            }
+        }
+        catch (error) {
+            fail('vector-round-trip', `${where}: writing and reading back threw ${thrown(error)}`);
+        }
+    });
+    return violations;
+}
+//# sourceMappingURL=payload-type.js.map

package/dist/conformance/payload-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload-type.js","sourceRoot":"","sources":["../../src/conformance/payload-type.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAqB7C;;;GAGG;AACH,SAAS,IAAI,CAAC,CAAU,EAAE,CAAU;IACnC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACjC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC7F,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,IAAI,GAAG,CAA4B,CAAC;IAC1C,MAAM,KAAK,GAAG,CAA4B,CAAC;IAC3C,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACpE,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED,oGAAoG;AACpG,SAAS,SAAS,CAAC,CAAU,EAAE,CAAU;IACxC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QAChF,OAAO,cAAc,CAAC;IACvB,CAAC;IACD,MAAM,IAAI,GAAG,CAA4B,CAAC;IAC1C,MAAM,KAAK,GAAG,CAA4B,CAAC;IAC3C,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACzE,OAAO,UAAU,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AAClF,CAAC;AAED,iGAAiG;AACjG,SAAS,MAAM,CAAC,KAAc;IAC7B,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;QAAE,OAAO,mBAAmB,CAAC;IAC1D,MAAM,IAAI,GAAI,KAA4B,CAAC,IAAI,CAAC;IAChD,OAAO,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;AACxE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC/B,IAAwB,EACxB,OAAyC;IAEzC,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,MAAc,EAAQ,EAAE;QACnD,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACnD,CAAC,CAAC;IACF,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QACzD,MAAM,KAAK,GAAG,UAAU,KAAK,EAAE,CAAC;QAChC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,IAAI,CAAC,eAAe,EAAE,GAAG,KAAK,kBAAkB,CAAC,CAAC;QACnF,IAAI,CAAC;YACJ,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACrC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,IAAI,CACH,cAAc,EACd,GAAG,KAAK,gCAAgC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CACxE,CAAC;YACH,CAAC;QACF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,cAAc,EAAE,GAAG,KAAK,+BAA+B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC9E,CAAC;QACD,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACvD,IAAI,OAAO,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;YACxC,oEAAoE;YACpE,mEAAmE;YACnE,gEAAgE;YAChE,IAAI,OAAO,GAAG,iBAAiB,CAAC;YAChC,IAAI,CAAC;gBACJ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,OAAO,GAAG,KAAK,YAAY,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACtE,CAAC;YACD,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;gBACpB,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,2BAA2B,CAAC,CAAC,CAAC,4BAA4B,CAAC;gBACjF,IAAI,CAAC,cAAc,EAAE,GAAG,KAAK,WAAW,OAAO,QAAQ,GAAG,mBAAmB,CAAC,CAAC;YAChF,CAAC;YACD,OAAO;QACR,CAAC;QACD,IAAI,CAAC;YACJ,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;YACxD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,IAAI,CACH,mBAAmB,EACnB,GAAG,KAAK,+CAA+C,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CACxF,CAAC;YACH,CAAC;QACF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,mBAAmB,EAAE,GAAG,KAAK,oCAAoC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACxF,CAAC;IACF,CAAC,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACnB,CAAC"}

package/dist/conformance/preset.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Conformance for presets.
+ *
+ * A preset is a promise that a design works, so each one must validate with
+ * no issue at all (no repairs, no warnings, which also means every finder
+ * pair it uses is one the design layer's model of the strict reader accepts,
+ * round a ring that is neither round nor dotted), have a finder the strict
+ * reader's own search finds and whose ring it traces as cornered (see
+ * finder.ts), build into a scene with no
+ * warning on small and medium symbols (a note, such as a logo made smaller
+ * to fit version 1, is allowed), ask for an error correction level its
+ * own list allows, and keep its colours readable: dark on light, every dark
+ * colour at least 4.5:1 against every ground colour by luminance (the WCAG
+ * formula), which is the floor; the catalogue aims for 7:1.
+ *
+ * Whether it scans at `minSizeMm` is the scan check's question, which lives
+ * in the verify layer above this one. It plugs in through `verify`.
+ */
+import type { DesignPaint, DesignRegistries, Ink, Preset, QrDesignV1 } from '../design/types.js';
+import type { BuiltSymbol } from '../symbology/types.js';
+import type { Violation } from './types.js';
+/** The floor every preset's colours must clear. */
+export declare const MIN_CONTRAST = 4.5;
+/** The strict scan check over a preset, supplied by the verify layer. */
+export type PresetVerifier = (preset: Preset, registries: DesignRegistries) => readonly Violation[];
+/** WCAG relative luminance of an ink. */
+export declare function luminance(ink: Ink): number;
+/** The WCAG contrast ratio between two inks, larger over smaller. */
+export declare function contrast(a: Ink, b: Ink): number;
+/** Every ink a paint can put down, including the colour parameters of an entry fill. */
+export declare function paintInks(paint: DesignPaint, registries: DesignRegistries): Ink[];
+/** The dark inks of a design: modules, finders and an icon logo. */
+export declare function darkInks(design: QrDesignV1, registries: DesignRegistries): Ink[];
+/** A QR symbol holding nothing, for building a scene without the encoder. */
+export declare function emptySymbol(version: string, ecLevel?: 'L' | 'M' | 'Q' | 'H'): BuiltSymbol;
+export declare function checkPreset(preset: Preset, verify?: PresetVerifier | null, registries?: DesignRegistries): Violation[];
+//# sourceMappingURL=preset.d.ts.map

package/dist/conformance/preset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preset.d.ts","sourceRoot":"","sources":["../../src/conformance/preset.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAOH,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAIjG,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,mDAAmD;AACnD,eAAO,MAAM,YAAY,MAAM,CAAC;AAEhC,yEAAyE;AACzE,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,KAAK,SAAS,SAAS,EAAE,CAAC;AAcpG,yCAAyC;AACzC,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAO1C;AAED,qEAAqE;AACrE,wBAAgB,QAAQ,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,GAAG,MAAM,CAI/C;AAED,wFAAwF;AACxF,wBAAgB,SAAS,CAAC,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB,GAAG,GAAG,EAAE,CAoBjF;AAED,oEAAoE;AACpE,wBAAgB,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,gBAAgB,GAAG,GAAG,EAAE,CAQhF;AAED,6EAA6E;AAC7E,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAS,GAAG,WAAW,CAQ9F;AAED,wBAAgB,WAAW,CAC1B,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,cAAc,GAAG,IAAW,EACpC,UAAU,GAAE,gBAA2C,GACrD,SAAS,EAAE,CAoFb"}