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

package/dist/design/constraints.js

@@ -0,0 +1,194 @@
+/**
+ * Content constraints over a design.
+ *
+ * Some content fixes parts of the code: an EPC payment code must be at level
+ * M and no larger than version 13, and the Swiss QR-bill fixes everything (black
+ * on white, square modules, level M, 46 mm). The content wins, always, so
+ * the studio runs the design through this before every build and shows the
+ * issues it returns beside the controls they disabled. Nothing here fails:
+ * each constraint is applied, and each change it makes is reported.
+ *
+ * What the content prints over the code (the Swiss QR-bill's cross) comes
+ * back beside the design as `overlay`, for the caller to hand to
+ * `buildScene` with the design. It is not written into the design: a design
+ * is reused across codes and shared as a link, and the cross belongs to the
+ * bill, not to the look.
+ */
+import { issue } from '../core/issue.js';
+import { canonicalJson } from './canonical.js';
+import { defaultDesign } from './document.js';
+const LEVELS = ['L', 'M', 'Q', 'H'];
+const BLACK = { kind: 'solid', ink: '#000000' };
+const WHITE = { kind: 'solid', ink: '#ffffff' };
+function same(a, b) {
+    return canonicalJson(a) === canonicalJson(b);
+}
+/** The allowed level nearest `level`: the lowest allowed at or above it, else the highest allowed. */
+function nearestLevel(level, allowed) {
+    const rank = LEVELS.indexOf(level);
+    const sorted = [...allowed].sort((a, b) => LEVELS.indexOf(a) - LEVELS.indexOf(b));
+    return (sorted.find((candidate) => LEVELS.indexOf(candidate) >= rank) ??
+        sorted[sorted.length - 1]);
+}
+/** The same design in black on white, its shapes and layout untouched. */
+function blackOnWhite(design) {
+    const regions = {};
+    for (const role of ['finder', 'sub-finder', 'corner-finder']) {
+        const style = design.regions[role];
+        if (style !== undefined)
+            regions[role] = { outer: style.outer, inner: style.inner };
+    }
+    return {
+        ...design,
+        background: WHITE,
+        modules: { shape: design.modules.shape, paint: BLACK, light: null },
+        regions,
+        logo: design.logo === null
+            ? null
+            : {
+                ...design.logo,
+                plate: design.logo.plate === null ? null : { ...design.logo.plate, paint: WHITE },
+                ...(design.logo.source.kind === 'icon' ? { paint: BLACK } : {}),
+            },
+        // A caption loses its own paint and takes the frame's ink for where it
+        // sits, which in black on white is white on the frame's artwork and
+        // black beside it.
+        frame: design.frame === null
+            ? null
+            : {
+                ...design.frame,
+                paint: BLACK,
+                ...(design.frame.text === undefined
+                    ? {}
+                    : {
+                        text: { content: design.frame.text.content, fontId: design.frame.text.fontId },
+                    }),
+            },
+    };
+}
+export function applyConstraints(design, constraints) {
+    const issues = [];
+    if (constraints === undefined)
+        return { design, issues, overlay: null };
+    let out = design;
+    if (constraints.designLocked === true) {
+        // The look is fixed: the default design's, with the quiet zone no
+        // narrower than its. How the symbol is chosen beyond the level (version
+        // limits, mask, segmentation) is left to the other constraints, the
+        // output and the name to the person.
+        const base = defaultDesign();
+        const { boostEc: _boost, ecLevel: _level, symbology, ...choices } = design.symbol;
+        // Version names and masks belong to their symbology; only the
+        // segmentation carries over to another.
+        const kept = symbology === base.symbol.symbology
+            ? choices
+            : choices.segmentation === undefined
+                ? {}
+                : { segmentation: choices.segmentation };
+        const locked = {
+            ...base,
+            symbol: { ...base.symbol, ...kept },
+            quietZone: Math.max(design.quietZone, base.quietZone),
+            output: design.output,
+            ...(design.name === undefined ? {} : { name: design.name }),
+        };
+        if (!same({ ...locked, quietZone: 0 }, { ...design, quietZone: 0 })) {
+            issues.push(issue('design.issue.design-locked', [], 'warning'));
+        }
+        out = locked;
+    }
+    if (constraints.colours === 'black-on-white') {
+        const recoloured = blackOnWhite(out);
+        if (!same(recoloured, out))
+            issues.push(issue('design.issue.colours-constrained', [], 'warning'));
+        out = recoloured;
+    }
+    if (constraints.symbologies !== undefined && constraints.symbologies.length > 0) {
+        if (!constraints.symbologies.includes(out.symbol.symbology)) {
+            const symbology = constraints.symbologies[0];
+            const { ecLevel, boostEc, segmentation } = out.symbol;
+            out = {
+                ...out,
+                symbol: {
+                    symbology,
+                    ...(ecLevel === undefined ? {} : { ecLevel }),
+                    ...(boostEc === undefined ? {} : { boostEc }),
+                    ...(segmentation === undefined ? {} : { segmentation }),
+                },
+            };
+            issues.push(issue('design.issue.symbology-constrained', ['symbol', 'symbology'], 'warning'));
+        }
+    }
+    if (constraints.ecLevels !== undefined && constraints.ecLevels.length > 0) {
+        const allowed = constraints.ecLevels;
+        const level = out.symbol.ecLevel ?? 'M';
+        const chosen = allowed.includes(level) ? level : nearestLevel(level, allowed);
+        if (chosen !== out.symbol.ecLevel) {
+            if (out.symbol.ecLevel !== undefined) {
+                issues.push(issue('design.issue.ec-level-constrained', ['symbol', 'ecLevel'], 'warning', {
+                    level: chosen,
+                }));
+            }
+            out = { ...out, symbol: { ...out.symbol, ecLevel: chosen } };
+        }
+        // Raising the level as far as it fits could leave the allowed set.
+        const above = LEVELS.slice(LEVELS.indexOf(chosen));
+        if (out.symbol.boostEc === true && !above.every((candidate) => allowed.includes(candidate))) {
+            out = { ...out, symbol: { ...out.symbol, boostEc: false } };
+            issues.push(issue('design.issue.boost-constrained', ['symbol', 'boostEc'], 'warning'));
+        }
+    }
+    if (constraints.maxVersion !== undefined && out.symbol.symbology === 'qr') {
+        const limit = Number(constraints.maxVersion);
+        const current = out.symbol.maxVersion === undefined ? undefined : Number(out.symbol.maxVersion);
+        if (current === undefined || current > limit) {
+            if (current !== undefined) {
+                issues.push(issue('design.issue.version-constrained', ['symbol', 'maxVersion'], 'warning', {
+                    max: limit,
+                }));
+            }
+            const min = out.symbol.minVersion === undefined ? undefined : Number(out.symbol.minVersion);
+            const symbol = { ...out.symbol, maxVersion: constraints.maxVersion };
+            if (min !== undefined && min > limit) {
+                delete symbol.minVersion;
+                issues.push(issue('design.issue.version-constrained', ['symbol', 'minVersion'], 'warning', {
+                    max: limit,
+                }));
+            }
+            out = { ...out, symbol };
+        }
+    }
+    if (constraints.eci === 'never' && out.symbol.segmentation?.eci !== 'never') {
+        if (out.symbol.segmentation?.eci !== undefined) {
+            issues.push(issue('design.issue.eci-constrained', ['symbol', 'segmentation', 'eci'], 'warning'));
+        }
+        out = {
+            ...out,
+            symbol: { ...out.symbol, segmentation: { ...out.symbol.segmentation, eci: 'never' } },
+        };
+    }
+    // A content type's size is the symbol's own, without its quiet zone or
+    // frame: the Swiss QR-bill's 46 mm is the code alone (guidelines v2.4,
+    // section 6.4), so the code and its 7 mm cross print the same at every
+    // version, whatever margin is added round them.
+    if (constraints.sizeMm !== undefined &&
+        (out.output.sizeMm !== constraints.sizeMm || out.output.sizeBasis !== 'symbol')) {
+        if (out.output.sizeMm !== undefined) {
+            issues.push(issue('design.issue.size-constrained', ['output', 'sizeMm'], 'warning', {
+                size: constraints.sizeMm,
+            }));
+        }
+        out = {
+            ...out,
+            output: { ...out.output, sizeMm: constraints.sizeMm, sizeBasis: 'symbol' },
+        };
+    }
+    // The overlay is drawn, not reported: the person cannot change it, and
+    // the scene shows it.
+    return {
+        design: out,
+        issues,
+        overlay: constraints.overlay === 'swiss-cross' ? 'swiss-cross' : null,
+    };
+}
+//# sourceMappingURL=constraints.js.map

package/dist/design/constraints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constraints.js","sourceRoot":"","sources":["../../src/design/constraints.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAGzC,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAS9C,MAAM,MAAM,GAAuB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,MAAM,KAAK,GAAgB,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;AAC7D,MAAM,KAAK,GAAgB,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;AAE7D,SAAS,IAAI,CAAC,CAAU,EAAE,CAAU;IACnC,OAAO,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,sGAAsG;AACtG,SAAS,YAAY,CAAC,KAAc,EAAE,OAA2B;IAChE,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAClF,OAAO,CACN,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;QAC5D,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAa,CACtC,CAAC;AACH,CAAC;AAED,0EAA0E;AAC1E,SAAS,YAAY,CAAC,MAAkB;IACvC,MAAM,OAAO,GAA8D,EAAE,CAAC;IAC9E,KAAK,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,YAAY,EAAE,eAAe,CAAU,EAAE,CAAC;QACvE,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;IACrF,CAAC;IACD,OAAO;QACN,GAAG,MAAM;QACT,UAAU,EAAE,KAAK;QACjB,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE;QACnE,OAAO;QACP,IAAI,EACH,MAAM,CAAC,IAAI,KAAK,IAAI;YACnB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC;gBACA,GAAG,MAAM,CAAC,IAAI;gBACd,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;gBACjF,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC/D;QACJ,uEAAuE;QACvE,oEAAoE;QACpE,mBAAmB;QACnB,KAAK,EACJ,MAAM,CAAC,KAAK,KAAK,IAAI;YACpB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC;gBACA,GAAG,MAAM,CAAC,KAAK;gBACf,KAAK,EAAE,KAAK;gBACZ,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS;oBAClC,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC;wBACA,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE;qBAC9E,CAAC;aACJ;KACJ,CAAC;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC/B,MAAkB,EAClB,WAA0C;IAO1C,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,IAAI,WAAW,KAAK,SAAS;QAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACxE,IAAI,GAAG,GAAG,MAAM,CAAC;IAEjB,IAAI,WAAW,CAAC,YAAY,KAAK,IAAI,EAAE,CAAC;QACvC,kEAAkE;QAClE,wEAAwE;QACxE,oEAAoE;QACpE,qCAAqC;QACrC,MAAM,IAAI,GAAG,aAAa,EAAE,CAAC;QAC7B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC;QAClF,8DAA8D;QAC9D,wCAAwC;QACxC,MAAM,IAAI,GACT,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,SAAS;YAClC,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,OAAO,CAAC,YAAY,KAAK,SAAS;gBACnC,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,YAAY,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAe;YAC1B,GAAG,IAAI;YACP,MAAM,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE;YACnC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC;YACrD,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;SAC3D,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;YACrE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,4BAA4B,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QACjE,CAAC;QACD,GAAG,GAAG,MAAM,CAAC;IACd,CAAC;IAED,IAAI,WAAW,CAAC,OAAO,KAAK,gBAAgB,EAAE,CAAC;QAC9C,MAAM,UAAU,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,kCAAkC,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QACvE,GAAG,GAAG,UAAU,CAAC;IAClB,CAAC;IAED,IAAI,WAAW,CAAC,WAAW,KAAK,SAAS,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjF,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC7D,MAAM,SAAS,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC,CAAW,CAAC;YACvD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;YACtD,GAAG,GAAG;gBACL,GAAG,GAAG;gBACN,MAAM,EAAE;oBACP,SAAS;oBACT,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;oBAC7C,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;oBAC7C,GAAG,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC;iBACvD;aACD,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,oCAAoC,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;QAC9F,CAAC;IACF,CAAC;IAED,IAAI,WAAW,CAAC,QAAQ,KAAK,SAAS,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3E,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC;QACrC,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,GAAG,CAAC;QACxC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC9E,IAAI,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACnC,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBACtC,MAAM,CAAC,IAAI,CACV,KAAK,CAAC,mCAAmC,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE;oBAC5E,KAAK,EAAE,MAAM;iBACb,CAAC,CACF,CAAC;YACH,CAAC;YACD,GAAG,GAAG,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;QAC9D,CAAC;QACD,mEAAmE;QACnE,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACnD,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAC7F,GAAG,GAAG,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC;YAC5D,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,gCAAgC,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;QACxF,CAAC;IACF,CAAC;IAED,IAAI,WAAW,CAAC,UAAU,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;QAC3E,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAChG,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,GAAG,KAAK,EAAE,CAAC;YAC9C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC3B,MAAM,CAAC,IAAI,CACV,KAAK,CAAC,kCAAkC,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,SAAS,EAAE;oBAC9E,GAAG,EAAE,KAAK;iBACV,CAAC,CACF,CAAC;YACH,CAAC;YACD,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5F,MAAM,MAAM,GAAG,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,CAAC,UAAU,EAAE,CAAC;YACrE,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,GAAG,KAAK,EAAE,CAAC;gBACtC,OAAQ,MAAkC,CAAC,UAAU,CAAC;gBACtD,MAAM,CAAC,IAAI,CACV,KAAK,CAAC,kCAAkC,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE,SAAS,EAAE;oBAC9E,GAAG,EAAE,KAAK;iBACV,CAAC,CACF,CAAC;YACH,CAAC;YACD,GAAG,GAAG,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,CAAC;QAC1B,CAAC;IACF,CAAC;IAED,IAAI,WAAW,CAAC,GAAG,KAAK,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,KAAK,OAAO,EAAE,CAAC;QAC7E,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,KAAK,SAAS,EAAE,CAAC;YAChD,MAAM,CAAC,IAAI,CACV,KAAK,CAAC,8BAA8B,EAAE,CAAC,QAAQ,EAAE,cAAc,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,CACnF,CAAC;QACH,CAAC;QACD,GAAG,GAAG;YACL,GAAG,GAAG;YACN,MAAM,EAAE,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;SACrF,CAAC;IACH,CAAC;IAED,uEAAuE;IACvE,uEAAuE;IACvE,uEAAuE;IACvE,gDAAgD;IAChD,IACC,WAAW,CAAC,MAAM,KAAK,SAAS;QAChC,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,WAAW,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,SAAS,KAAK,QAAQ,CAAC,EAC9E,CAAC;QACF,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,CAAC,IAAI,CACV,KAAK,CAAC,+BAA+B,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,SAAS,EAAE;gBACvE,IAAI,EAAE,WAAW,CAAC,MAAM;aACxB,CAAC,CACF,CAAC;QACH,CAAC;QACD,GAAG,GAAG;YACL,GAAG,GAAG;YACN,MAAM,EAAE,EAAE,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE;SAC1E,CAAC;IACH,CAAC;IAED,uEAAuE;IACvE,sBAAsB;IACtB,OAAO;QACN,MAAM,EAAE,GAAG;QACX,MAAM;QACN,OAAO,EAAE,WAAW,CAAC,OAAO,KAAK,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI;KACrE,CAAC;AACH,CAAC"}

package/dist/design/document.d.ts

@@ -0,0 +1,64 @@
+/**
+ * The design document's defaults and limits.
+ *
+ * A design is plain JSON so it can be saved, put in a link and read by a
+ * person, and it never holds the content of the code: one design is reused
+ * across many codes, and a link to it must be safe to share. The limits below
+ * are what the validator and the link codec enforce; each is far past any
+ * design a person would make, and each keeps a hostile file from costing more
+ * than a moment to refuse.
+ */
+import type { QrDesignV1 } from './types.js';
+/** The design schema version this build writes and reads. */
+export declare const DESIGN_VERSION = 1;
+/** The quiet zone each built-in symbology needs at the least, in modules. */
+export declare const MIN_QUIET_ZONE: Readonly<Record<string, number>>;
+export declare const LIMITS: Readonly<{
+    /** The widest quiet zone a design may ask for, in modules. */
+    quietZone: 20;
+    /** Stops in one gradient. */
+    stops: 16;
+    /** Embedded images in one design. */
+    assets: 4;
+    /** Bytes of PNG per embedded image, decoded from its base64. */
+    assetBytes: number;
+    /** Pixels on either side of an embedded image. */
+    assetSide: 1024;
+    /** Characters in a design's name. */
+    name: 80;
+    /** Characters in a frame caption, whatever the frame allows. */
+    caption: 200;
+    /** Printed size, in millimetres. */
+    sizeMm: {
+        min: number;
+        max: number;
+    };
+    dpi: {
+        min: number;
+        max: number;
+    };
+    /** The logo's width as a fraction of the symbol's. */
+    logoSize: {
+        min: number;
+        max: number;
+    };
+    /** Clear space round the logo, in modules. */
+    logoPadding: {
+        min: number;
+        max: number;
+    };
+    /** Gradient centres, as fractions of the box, and the radial radius. */
+    centre: {
+        min: number;
+        max: number;
+    };
+    radius: {
+        min: number;
+        max: number;
+    };
+    /** How deep a design file may nest before it is refused unread. */
+    depth: 32;
+}>;
+/** Classic black on white: square modules, square finders, quiet zone 4, error correction M. */
+export declare function defaultDesign(): QrDesignV1;
+//# sourceMappingURL=document.d.ts.map

package/dist/design/document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../src/design/document.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,6DAA6D;AAC7D,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,6EAA6E;AAC7E,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAI1D,CAAC;AAEH,eAAO,MAAM,MAAM;IAClB,8DAA8D;;IAE9D,6BAA6B;;IAE7B,qCAAqC;;IAErC,gEAAgE;;IAEhE,kDAAkD;;IAElD,qCAAqC;;IAErC,gEAAgE;;IAEhE,oCAAoC;;;;;;;;;IAGpC,sDAAsD;;;;;IAEtD,8CAA8C;;;;;IAE9C,wEAAwE;;;;;;;;;IAGxE,mEAAmE;;EAElE,CAAC;AAEH,gGAAgG;AAChG,wBAAgB,aAAa,IAAI,UAAU,CAiB1C"}

package/dist/design/document.js

@@ -0,0 +1,66 @@
+/**
+ * The design document's defaults and limits.
+ *
+ * A design is plain JSON so it can be saved, put in a link and read by a
+ * person, and it never holds the content of the code: one design is reused
+ * across many codes, and a link to it must be safe to share. The limits below
+ * are what the validator and the link codec enforce; each is far past any
+ * design a person would make, and each keeps a hostile file from costing more
+ * than a moment to refuse.
+ */
+/** The design schema version this build writes and reads. */
+export const DESIGN_VERSION = 1;
+/** The quiet zone each built-in symbology needs at the least, in modules. */
+export const MIN_QUIET_ZONE = Object.freeze({
+    qr: 4,
+    micro: 2,
+    rmqr: 2,
+});
+export const LIMITS = Object.freeze({
+    /** The widest quiet zone a design may ask for, in modules. */
+    quietZone: 20,
+    /** Stops in one gradient. */
+    stops: 16,
+    /** Embedded images in one design. */
+    assets: 4,
+    /** Bytes of PNG per embedded image, decoded from its base64. */
+    assetBytes: 512 * 1024,
+    /** Pixels on either side of an embedded image. */
+    assetSide: 1024,
+    /** Characters in a design's name. */
+    name: 80,
+    /** Characters in a frame caption, whatever the frame allows. */
+    caption: 200,
+    /** Printed size, in millimetres. */
+    sizeMm: { min: 5, max: 2000 },
+    dpi: { min: 72, max: 2400 },
+    /** The logo's width as a fraction of the symbol's. */
+    logoSize: { min: 0.05, max: 0.4 },
+    /** Clear space round the logo, in modules. */
+    logoPadding: { min: 0, max: 4 },
+    /** Gradient centres, as fractions of the box, and the radial radius. */
+    centre: { min: -1, max: 2 },
+    radius: { min: 0.01, max: 4 },
+    /** How deep a design file may nest before it is refused unread. */
+    depth: 32,
+});
+/** Classic black on white: square modules, square finders, quiet zone 4, error correction M. */
+export function defaultDesign() {
+    return {
+        schema: 'qr-design',
+        version: 1,
+        symbol: { symbology: 'qr', ecLevel: 'M' },
+        quietZone: 4,
+        background: { kind: 'solid', ink: '#ffffff' },
+        modules: {
+            shape: { id: 'square' },
+            paint: { kind: 'solid', ink: '#000000' },
+            light: null,
+        },
+        regions: {},
+        logo: null,
+        frame: null,
+        output: { colourSpace: 'srgb' },
+    };
+}
+//# sourceMappingURL=document.js.map

package/dist/design/document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../../src/design/document.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,6DAA6D;AAC7D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC;AAEhC,6EAA6E;AAC7E,MAAM,CAAC,MAAM,cAAc,GAAqC,MAAM,CAAC,MAAM,CAAC;IAC7E,EAAE,EAAE,CAAC;IACL,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;CACP,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IACnC,8DAA8D;IAC9D,SAAS,EAAE,EAAE;IACb,6BAA6B;IAC7B,KAAK,EAAE,EAAE;IACT,qCAAqC;IACrC,MAAM,EAAE,CAAC;IACT,gEAAgE;IAChE,UAAU,EAAE,GAAG,GAAG,IAAI;IACtB,kDAAkD;IAClD,SAAS,EAAE,IAAI;IACf,qCAAqC;IACrC,IAAI,EAAE,EAAE;IACR,gEAAgE;IAChE,OAAO,EAAE,GAAG;IACZ,oCAAoC;IACpC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE;IAC7B,GAAG,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;IAC3B,sDAAsD;IACtD,QAAQ,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE;IACjC,8CAA8C;IAC9C,WAAW,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE;IAC/B,wEAAwE;IACxE,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE;IAC3B,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE;IAC7B,mEAAmE;IACnE,KAAK,EAAE,EAAE;CACT,CAAC,CAAC;AAEH,gGAAgG;AAChG,MAAM,UAAU,aAAa;IAC5B,OAAO;QACN,MAAM,EAAE,WAAW;QACnB,OAAO,EAAE,CAAC;QACV,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE;QACzC,SAAS,EAAE,CAAC;QACZ,UAAU,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE;QAC7C,OAAO,EAAE;YACR,KAAK,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE;YACvB,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE;YACxC,KAAK,EAAE,IAAI;SACX;QACD,OAAO,EAAE,EAAE;QACX,IAAI,EAAE,IAAI;QACV,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;KAC/B,CAAC;AACH,CAAC"}

package/dist/design/finder.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Measuring a finder the way a strict reader sees it.
+ *
+ * A reader finds a finder by the ratio of dark and light runs along lines
+ * through its centre: 1:1:3:1:1 for the 7 by 7 finder, 1:1:1:1:1 for rMQR's
+ * 5 by 5 sub-finder. The strict profile allows 0.35 of a module per run,
+ * three times that for the 3 module centre, after estimating the module from
+ * the whole pattern's length, and it checks both diagonals as well as the
+ * axes. This file draws a ring and a centre at 4 pixels a module, thresholds
+ * them, and measures that with sub-pixel edges from the exact centre.
+ *
+ * On the axes the runs are also held to their nominal lengths in modules,
+ * not only to the ratio, because the reader takes its module size for the
+ * rest of the symbol from the finder: a finder that is the right shape but
+ * the wrong size would throw every later sample off.
+ *
+ * The diagonals are held to 0.35 here although the strict reader allows them
+ * half a module. That half module is slack for the reader's own error (it
+ * walks whole pixel steps from a centre it knows to the nearest pixel), and
+ * this measurement has none: given half a module too, it accepts 73 more of
+ * the catalogue's pairs at sampled settings, and the strict reader misses 34
+ * of those at some density from 5 pixels a module, phase or small roll.
+ *
+ * Pairs are checked rather than shapes because the diagonals depend on both:
+ * a round ring round a square centre leaves too little light past the
+ * centre's corners. `regionPairConforms` is what the validator, the scene
+ * builder and the studio's pair table ask.
+ *
+ * This is a model of the strict reader, and the model is what runs when a
+ * design is validated or drawn, because the root of the package must not
+ * pull in the decoder. The strict reader's own tests (`strictFindsFinder`,
+ * `ringKind`) are asked in the conformance suite instead, which holds every
+ * built-in ring and centre to them: no pair this file accepts may be one the
+ * strict reader misses, and no ring may trace differently from its
+ * `ringKind`. Readers trace a ring's sides as well as cross it (see
+ * `ringKind` in decode), so a ring that says it is `dotted` is never a
+ * finder here; a `round` one is, with a warning from the validator.
+ */
+import { PathBuilder } from '../geometry/path.js';
+import type { Path } from '../geometry/path.js';
+import type { ModuleFamily, ModuleShape, RegionKind, RegionShape, ResolvedParams, RingKind } from './types.js';
+/** Slack per run, in modules, as the strict reader allows it on the axes. */
+export declare const FINDER_TOLERANCE = 0.35;
+/** The narrowest the light ring between ring and centre may be, in modules. */
+export declare const LIGHT_RING_MIN = 0.6;
+/** Pixels a module the runs are measured at. */
+export declare const FINDER_PIXELS = 4;
+export interface FinderProblem {
+    readonly rule: 'finder-runs' | 'light-ring' | 'ring-not-traceable';
+    readonly detail: string;
+}
+/** What a ring says it is to a reader that traces its sides; `cornered` unless it says otherwise. */
+export declare function ringKindOf(shape: RegionShape): RingKind;
+/** A region shape's path in its own box, moved by (dx, dy). */
+export declare function regionPath(shape: RegionShape, kind: RegionKind, params: ResolvedParams, dx?: number, dy?: number, out?: PathBuilder): Path;
+/** The narrowest gap between the outlines of two paths, in their units. */
+export declare function outlineGap(a: Path, b: Path): number;
+/**
+ * Everything wrong with a ring and centre as a finder of `kind`, measured as
+ * the strict reader would. Empty when the pair is a good finder.
+ */
+export declare function finderProblems(outer: RegionShape, outerParams: ResolvedParams, inner: RegionShape, innerParams: ResolvedParams, kind: 'concentric-7' | 'concentric-5'): FinderProblem[];
+/** The family of finder pairs a module shape is drawn with; `square` when it does not say, or there is none. */
+export declare function moduleFamilyOf(shape: ModuleShape | undefined): ModuleFamily;
+/**
+ * True when this ring and this centre make a finder of `kind` the strict
+ * reader finds, among modules of `family` (default `square`). Remembered per
+ * pair of shapes and their parameters, since a design asks about the same
+ * pair on every rebuild; keyed by the shapes themselves, so two registries'
+ * entries of the same name never share an answer.
+ *
+ * The runs measured here hold for every family; a QR finder is also held to
+ * what the ring says about the family (`unpaired`), which captures of the
+ * pair among those modules measured. The alignment patterns take the
+ * finder's style and were in those captures, so the smaller kind is asked
+ * about by runs alone.
+ */
+export declare function regionPairConforms(outer: RegionShape, outerParams: ResolvedParams, inner: RegionShape, innerParams: ResolvedParams, kind: 'concentric-7' | 'concentric-5', family?: ModuleFamily): boolean;
+//# sourceMappingURL=finder.d.ts.map

package/dist/design/finder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"finder.d.ts","sourceRoot":"","sources":["../../src/design/finder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAEhD,OAAO,KAAK,EACX,YAAY,EACZ,WAAW,EACX,UAAU,EACV,WAAW,EACX,cAAc,EACd,QAAQ,EACR,MAAM,YAAY,CAAC;AAEpB,6EAA6E;AAC7E,eAAO,MAAM,gBAAgB,OAAO,CAAC;AACrC,+EAA+E;AAC/E,eAAO,MAAM,cAAc,MAAM,CAAC;AAClC,gDAAgD;AAChD,eAAO,MAAM,aAAa,IAAI,CAAC;AAE/B,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,YAAY,GAAG,oBAAoB,CAAC;IACnE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACxB;AAED,qGAAqG;AACrG,wBAAgB,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,QAAQ,CAEvD;AAED,+DAA+D;AAC/D,wBAAgB,UAAU,CACzB,KAAK,EAAE,WAAW,EAClB,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,cAAc,EACtB,EAAE,SAAI,EACN,EAAE,SAAI,EACN,GAAG,GAAE,WAA+B,GAClC,IAAI,CAIN;AA+FD,2EAA2E;AAC3E,wBAAgB,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,GAAG,MAAM,CAoBnD;AAMD;;;GAGG;AACH,wBAAgB,cAAc,CAC7B,KAAK,EAAE,WAAW,EAClB,WAAW,EAAE,cAAc,EAC3B,KAAK,EAAE,WAAW,EAClB,WAAW,EAAE,cAAc,EAC3B,IAAI,EAAE,cAAc,GAAG,cAAc,GACnC,aAAa,EAAE,CA2FjB;AAID,gHAAgH;AAChH,wBAAgB,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,YAAY,CAE3E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CACjC,KAAK,EAAE,WAAW,EAClB,WAAW,EAAE,cAAc,EAC3B,KAAK,EAAE,WAAW,EAClB,WAAW,EAAE,cAAc,EAC3B,IAAI,EAAE,cAAc,GAAG,cAAc,EACrC,MAAM,GAAE,YAAuB,GAC7B,OAAO,CAqBT"}