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

package/dist/batch/plan.js

@@ -0,0 +1,254 @@
+/**
+ * From a table and a mapping to the rows a batch will make: each row's
+ * content, built and validated by its content type, and its file name.
+ *
+ * A cell is text, and a content type's fields are text, numbers, yes or no
+ * and lists, so each cell is read as its field's kind:
+ *
+ * - Text, multi-line text and secrets exactly as written, spaces and all; a
+ *   Wi-Fi password can start with a space.
+ * - Other text kinds (links, addresses, numbers to dial, dates, codes) with
+ *   the spaces round them dropped, which a spreadsheet adds and a reader
+ *   does not want. Currency, country and BIC codes in capitals; a choice
+ *   matched to its option ignoring case.
+ * - Numbers only as a plain decimal with a full stop, as CSV writes them in
+ *   English. A comma or a thousands separator is refused with its own issue
+ *   rather than guessed at: "1,250" is a thousand and a quarter in one
+ *   country and one and a quarter in the next, and this may be an amount of
+ *   money.
+ * - Yes or no from true, false, yes, no, y, n, 1, 0, on and off, in any case,
+ *   which covers what Excel, Sheets and people write.
+ * - A list (a contact card's phone numbers, an email's recipients) split at
+ *   line breaks, and also at semicolons and commas for addresses and numbers
+ *   (neither can contain one) and at spaces for links (which cannot either).
+ *
+ * An empty cell takes the field's default, as an untouched form would show
+ * it, and a field the mapping leaves out does too. Every row is then checked
+ * by the content type exactly as the form is, so a batch never makes a code
+ * the studio would refuse to.
+ */
+import { hasErrors, issue } from '../core/issue.js';
+import { UnknownColumnError } from './errors.js';
+import { sanitiseFilename, uniqueFilenames } from './filename.js';
+import { BATCH_ISSUES } from './issues.js';
+import { compileTemplate, fillTemplate, findColumn } from './template.js';
+const PLAIN_NUMBER = /^[+-]?(?:\d+(?:\.\d*)?|\.\d+)(?:[eE][+-]?\d+)?$/;
+/** Digits with commas, dots, spaces or apostrophes between them: a number written for a person. */
+const GROUPED_NUMBER = /^[+-]?\d[\d.,'\s\u00a0\u202f]*$/;
+const TRUE = new Set(['true', 'yes', 'y', '1', 'on']);
+const FALSE = new Set(['false', 'no', 'n', '0', 'off']);
+/** Kinds taken exactly as written. */
+const VERBATIM = new Set(['text', 'multiline', 'secret']);
+/** Kinds written in capitals. */
+const CAPITALS = new Set(['currency', 'country', 'bic']);
+const NUMBERS = new Set(['number', 'integer', 'amount', 'latitude', 'longitude']);
+function emptyValue(field) {
+    if (field.default !== undefined)
+        return field.default;
+    if (field.multiple)
+        return [];
+    if (NUMBERS.has(field.kind) || field.kind === 'boolean')
+        return null;
+    return '';
+}
+function splitList(field, text) {
+    const separator = field.kind === 'email' || field.kind === 'tel'
+        ? /[;,\r\n]+/
+        : field.kind === 'url'
+            ? /\s+/
+            : /\r?\n/;
+    return text
+        .split(separator)
+        .map((item) => item.trim())
+        .filter((item) => item !== '');
+}
+/** A cell as its field's kind, and an issue when it cannot be read as one without guessing. */
+function cellValue(field, text) {
+    if (field.multiple) {
+        const items = splitList(field, text);
+        return { value: items.length === 0 ? emptyValue(field) : items };
+    }
+    if (VERBATIM.has(field.kind))
+        return { value: text === '' ? emptyValue(field) : text };
+    const trimmed = text.trim();
+    if (trimmed === '')
+        return { value: emptyValue(field) };
+    if (NUMBERS.has(field.kind)) {
+        if (PLAIN_NUMBER.test(trimmed))
+            return { value: Number(trimmed) };
+        if (GROUPED_NUMBER.test(trimmed)) {
+            return {
+                value: Number.NaN,
+                issue: issue(BATCH_ISSUES.numberFormat, ['fields', field.key]),
+            };
+        }
+        // Not a number at all; validation says so in its own words.
+        return { value: Number.NaN };
+    }
+    if (field.kind === 'boolean') {
+        const lower = trimmed.toLowerCase();
+        if (TRUE.has(lower))
+            return { value: true };
+        if (FALSE.has(lower))
+            return { value: false };
+        // Left as text, which validation reports as the wrong kind of value.
+        return { value: trimmed };
+    }
+    if (field.kind === 'select') {
+        const lower = trimmed.toLowerCase();
+        const option = field.options?.find((candidate) => candidate.value.toLowerCase() === lower);
+        return { value: option?.value ?? trimmed };
+    }
+    if (CAPITALS.has(field.kind))
+        return { value: trimmed.toUpperCase() };
+    return { value: trimmed };
+}
+function checkTable(table) {
+    if (typeof table !== 'object' ||
+        table === null ||
+        !Array.isArray(table.headers) ||
+        !Array.isArray(table.rows) ||
+        !table.headers.every((header) => typeof header === 'string')) {
+        throw new TypeError('planBatch: table is what parseCsv returns.');
+    }
+    table.rows.forEach((row, index) => {
+        if (!Array.isArray(row) || !row.every((cell) => typeof cell === 'string')) {
+            throw new TypeError(`planBatch: row ${index} is a list of strings.`);
+        }
+    });
+    if (table.rowNumbers !== undefined) {
+        if (!Array.isArray(table.rowNumbers) ||
+            table.rowNumbers.length !== table.rows.length ||
+            !table.rowNumbers.every((number) => Number.isInteger(number) && number >= 2)) {
+            throw new TypeError('planBatch: table.rowNumbers gives a row number from 2 for every row.');
+        }
+    }
+}
+function isSource(value) {
+    if (typeof value !== 'object' || value === null)
+        return false;
+    const keys = Object.keys(value);
+    if (keys.length !== 1)
+        return false;
+    const source = value;
+    return ((keys[0] === 'column' && typeof source.column === 'string') ||
+        (keys[0] === 'template' && typeof source.template === 'string'));
+}
+function compileFields(type, mapping, headers) {
+    if (typeof mapping.fields !== 'object' || mapping.fields === null) {
+        throw new TypeError('planBatch: mapping.fields is an object of field sources.');
+    }
+    const compiled = [];
+    for (const key of Object.keys(mapping.fields)) {
+        const field = type.fields.find((candidate) => candidate.key === key);
+        if (field === undefined) {
+            throw new TypeError(`planBatch: this content type has no field called ${JSON.stringify(key)}.`);
+        }
+        const source = mapping.fields[key];
+        if (!isSource(source)) {
+            throw new TypeError(`planBatch: the source of field ${JSON.stringify(key)} is { column } or { template }.`);
+        }
+        let template;
+        if ('column' in source) {
+            const index = findColumn(headers, source.column);
+            if (index === -1)
+                throw new UnknownColumnError({ part: 'field', field: key });
+            template = { parts: [{ index }], columns: [index] };
+        }
+        else {
+            const result = compileTemplate(source.template, headers);
+            if ('missing' in result)
+                throw new UnknownColumnError({ part: 'field', field: key });
+            template = result;
+        }
+        compiled.push({ field, template });
+    }
+    // In the type's own field order, so issues come out in the order a form shows them.
+    return compiled.sort((a, b) => type.fields.indexOf(a.field) - type.fields.indexOf(b.field));
+}
+/** The rows of a batch: content and file name for each, every problem as an issue on its row. */
+export function planBatch(table, mapping, registries) {
+    checkTable(table);
+    if (typeof mapping !== 'object' || mapping === null || typeof mapping.typeId !== 'string') {
+        throw new TypeError('planBatch: mapping gives at least the content type.');
+    }
+    if (typeof mapping.filename !== 'string') {
+        throw new TypeError('planBatch: mapping.filename is a template string.');
+    }
+    if (typeof registries !== 'object' || registries === null || !registries.payloads) {
+        throw new TypeError('planBatch: registries gives at least the content types.');
+    }
+    const type = registries.payloads.require(mapping.typeId);
+    if (type.generate === false) {
+        throw new TypeError('planBatch: this content type can be read but not made.');
+    }
+    const fields = compileFields(type, mapping, table.headers);
+    const filename = compileTemplate(mapping.filename, table.headers);
+    if ('missing' in filename)
+        throw new UnknownColumnError({ part: 'filename' });
+    const read = new Set(fields.flatMap((entry) => entry.template.columns));
+    // Reading the file's own warnings, by the row they belong to.
+    const tableIssues = new Map();
+    for (const found of table.issues ?? []) {
+        if (found.path[0] !== 'rows' || typeof found.path[1] !== 'number')
+            continue;
+        const list = tableIssues.get(found.path[1]) ?? [];
+        list.push(found);
+        tableIssues.set(found.path[1], list);
+    }
+    const drafts = table.rows.map((cells, index) => {
+        const rowNumber = table.rowNumbers?.[index] ?? index + 2;
+        const issues = [...(tableIssues.get(index) ?? [])];
+        let content = null;
+        if (read.size === 0 || [...read].every((column) => (cells[column] ?? '') === '')) {
+            issues.push(issue(BATCH_ISSUES.emptyRow, [], 'warning'));
+        }
+        else {
+            const value = {};
+            const unread = new Set();
+            const conversion = [];
+            for (const field of type.fields)
+                value[field.key] = emptyValue(field);
+            for (const { field, template } of fields) {
+                const text = fillTemplate(template, cells, field.kind === 'url' && !field.multiple);
+                const cell = cellValue(field, text);
+                value[field.key] = cell.value;
+                if (cell.issue !== undefined) {
+                    conversion.push(cell.issue);
+                    unread.add(field.key);
+                }
+            }
+            const validated = type
+                .validate(value)
+                .filter((found) => !unread.has(found.path[1]));
+            const found = [...conversion, ...validated];
+            issues.push(...found);
+            if (!hasErrors(found))
+                content = type.build(value).text;
+        }
+        const raw = fillTemplate(filename, cells, false);
+        const name = sanitiseFilename(raw);
+        if (name === '')
+            issues.push(issue(BATCH_ISSUES.filenameFallback, ['filename'], 'info'));
+        else if (name !== raw.trim()) {
+            issues.push(issue(BATCH_ISSUES.filenameCleaned, ['filename'], 'info'));
+        }
+        return { index, rowNumber, issues, content, name };
+    });
+    const names = uniqueFilenames(drafts.map((draft) => ({ name: draft.name, fallback: `qr-${draft.rowNumber}` })));
+    return Object.freeze(drafts.map((draft, i) => {
+        const unique = names[i];
+        if (unique.number !== null) {
+            draft.issues.push(issue(BATCH_ISSUES.filenameNumbered, ['filename'], 'info', { number: unique.number }));
+        }
+        return Object.freeze({
+            index: draft.index,
+            rowNumber: draft.rowNumber,
+            typeId: type.id,
+            filename: unique.name,
+            content: draft.content,
+            issues: Object.freeze(draft.issues),
+        });
+    }));
+}
+//# sourceMappingURL=plan.js.map

package/dist/batch/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../src/batch/plan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAGpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAI1E,MAAM,YAAY,GAAG,iDAAiD,CAAC;AACvE,mGAAmG;AACnG,MAAM,cAAc,GAAG,iCAAiC,CAAC;AAEzD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;AACtD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;AAExD,sCAAsC;AACtC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC1D,iCAAiC;AACjC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;AACzD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;AAElF,SAAS,UAAU,CAAC,KAAkB;IACrC,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,OAAO,CAAC;IACtD,IAAI,KAAK,CAAC,QAAQ;QAAE,OAAO,EAAE,CAAC;IAC9B,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACrE,OAAO,EAAE,CAAC;AACX,CAAC;AAED,SAAS,SAAS,CAAC,KAAkB,EAAE,IAAY;IAClD,MAAM,SAAS,GACd,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK;QAC7C,CAAC,CAAC,WAAW;QACb,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK;YACrB,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,OAAO,CAAC;IACb,OAAO,IAAI;SACT,KAAK,CAAC,SAAS,CAAC;SAChB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;AACjC,CAAC;AAED,+FAA+F;AAC/F,SAAS,SAAS,CAAC,KAAkB,EAAE,IAAY;IAClD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACpB,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACrC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAClE,CAAC;IACD,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,KAAK,EAAE,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACvF,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,IAAI,OAAO,KAAK,EAAE;QAAE,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;IACxD,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,IAAI,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC;YAAE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAClE,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,OAAO;gBACN,KAAK,EAAE,MAAM,CAAC,GAAG;gBACjB,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;aAC9D,CAAC;QACH,CAAC;QACD,4DAA4D;QAC5D,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;IAC9B,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACpC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAC5C,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QAC9C,qEAAqE;QACrE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IAC3B,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,CAAC;QAC3F,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,IAAI,OAAO,EAAE,CAAC;IAC5C,CAAC;IACD,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;IACtE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC3B,CAAC;AAOD,SAAS,UAAU,CAAC,KAAe;IAClC,IACC,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;QAC7B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;QAC1B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,EAC3D,CAAC;QACF,MAAM,IAAI,SAAS,CAAC,4CAA4C,CAAC,CAAC;IACnE,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;YAC3E,MAAM,IAAI,SAAS,CAAC,kBAAkB,KAAK,wBAAwB,CAAC,CAAC;QACtE,CAAC;IACF,CAAC,CAAC,CAAC;IACH,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACpC,IACC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;YAChC,KAAK,CAAC,UAAU,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM;YAC7C,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC,EAC3E,CAAC;YACF,MAAM,IAAI,SAAS,CAAC,sEAAsE,CAAC,CAAC;QAC7F,CAAC;IACF,CAAC;AACF,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACpC,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,OAAO,CACN,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC;QAC3D,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAC/D,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACrB,IAAiB,EACjB,OAAqB,EACrB,OAA0B;IAE1B,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;QACnE,MAAM,IAAI,SAAS,CAAC,0DAA0D,CAAC,CAAC;IACjF,CAAC;IACD,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QACrE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,SAAS,CAClB,oDAAoD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAC1E,CAAC;QACH,CAAC;QACD,MAAM,MAAM,GAAY,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,SAAS,CAClB,kCAAkC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,iCAAiC,CACtF,CAAC;QACH,CAAC;QACD,IAAI,QAA0B,CAAC;QAC/B,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YACjD,IAAI,KAAK,KAAK,CAAC,CAAC;gBAAE,MAAM,IAAI,kBAAkB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YAC9E,QAAQ,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;QACrD,CAAC;aAAM,CAAC;YACP,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACzD,IAAI,SAAS,IAAI,MAAM;gBAAE,MAAM,IAAI,kBAAkB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YACrF,QAAQ,GAAG,MAAM,CAAC;QACnB,CAAC;QACD,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;IACpC,CAAC;IACD,oFAAoF;IACpF,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7F,CAAC;AAED,iGAAiG;AACjG,MAAM,UAAU,SAAS,CACxB,KAAe,EACf,OAAqB,EACrB,UAA2B;IAE3B,UAAU,CAAC,KAAK,CAAC,CAAC;IAClB,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC3F,MAAM,IAAI,SAAS,CAAC,qDAAqD,CAAC,CAAC;IAC5E,CAAC;IACD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1C,MAAM,IAAI,SAAS,CAAC,mDAAmD,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;QACnF,MAAM,IAAI,SAAS,CAAC,yDAAyD,CAAC,CAAC;IAChF,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzD,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;QAC7B,MAAM,IAAI,SAAS,CAAC,wDAAwD,CAAC,CAAC;IAC/E,CAAC;IACD,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAClE,IAAI,SAAS,IAAI,QAAQ;QAAE,MAAM,IAAI,kBAAkB,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;IAC9E,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAExE,8DAA8D;IAC9D,MAAM,WAAW,GAAG,IAAI,GAAG,EAAmB,CAAC;IAC/C,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;QACxC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,MAAM,IAAI,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ;YAAE,SAAS;QAC5E,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAClD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjB,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QAC9C,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;QACzD,MAAM,MAAM,GAAY,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC5D,IAAI,OAAO,GAAkB,IAAI,CAAC;QAClC,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;YAClF,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACP,MAAM,KAAK,GAA+B,EAAE,CAAC;YAC7C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;YACjC,MAAM,UAAU,GAAY,EAAE,CAAC;YAC/B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM;gBAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;YACtE,KAAK,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,MAAM,EAAE,CAAC;gBAC1C,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACpF,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBACpC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;gBAC9B,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;oBAC9B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC5B,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACvB,CAAC;YACF,CAAC;YACD,MAAM,SAAS,GAAG,IAAI;iBACpB,QAAQ,CAAC,KAAqB,CAAC;iBAC/B,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC,CAAC,CAAC;YAC1D,MAAM,KAAK,GAAG,CAAC,GAAG,UAAU,EAAE,GAAG,SAAS,CAAC,CAAC;YAC5C,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAAE,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAqB,CAAC,CAAC,IAAI,CAAC;QACzE,CAAC;QACD,MAAM,GAAG,GAAG,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QACjD,MAAM,IAAI,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,KAAK,EAAE;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,gBAAgB,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;aACpF,IAAI,IAAI,KAAK,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,eAAe,CAC5B,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAChF,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CACnB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QACvB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAA4C,CAAC;QACnE,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAC5B,KAAK,CAAC,MAAM,CAAC,IAAI,CAChB,KAAK,CAAC,YAAY,CAAC,gBAAgB,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CACrF,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,MAAM,CAAC;YACpB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,MAAM,EAAE,IAAI,CAAC,EAAE;YACf,QAAQ,EAAE,MAAM,CAAC,IAAI;YACrB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;SACnC,CAAC,CAAC;IACJ,CAAC,CAAC,CACF,CAAC;AACH,CAAC"}

package/dist/batch/run.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Making the files: each row's code drawn in one design, written into a ZIP
+ * with a manifest, or laid out on label sheets as one PDF.
+ *
+ * `runBatch` is a generator the caller drives in time slices, because this
+ * package has no worker of its own (Chrome blocks blob workers under
+ * `file://`) and a thousand codes is far too long for one slice. Each
+ * `next()` makes one row, start to finish: encode, build the scene, draw it
+ * into its format, compress it into its ZIP entry, and the scan check when
+ * the row is one of those checked. So at most one row's pictures are alive
+ * at a time, and what the batch holds between slices is only the compressed
+ * entries (or, for a sheet, the scenes, which is what a sheet is made of).
+ *
+ * The same rows, design, output and options give the same bytes, every time
+ * and in every engine. Nothing is read from a clock: the ZIP's date is core's
+ * fixed 1980-01-01 unless one is passed, the design's seed is a parameter and
+ * is the same for every row, and entries go in row order with the manifest
+ * last.
+ *
+ * Content constraints win over the design, as they do in the studio: an EPC
+ * payment code is made at level M whatever the design says, and the Swiss
+ * QR-bill in black on white at 46 mm. The design is constrained once per
+ * content type and every row of that type is drawn with the result.
+ *
+ * A row is skipped, and listed in the manifest with why, when it has error
+ * issues from planning or when its content cannot be made into a code at
+ * these settings (too long, most often). Nothing a row holds can stop the
+ * others; a bug can, and does, as a TypeError.
+ */
+import { QrStudioError } from '../core/errors.js';
+import type { Issue } from '../core/issue.js';
+import type { QrDesignV1 } from '../design/types.js';
+import type { BatchOutput, BatchProgress, BatchRegistries, BatchRow, RunBatchOptions } from './types.js';
+/** A PNG's width when neither it nor a print size and resolution is given. */
+export declare const DEFAULT_WIDTH_PX = 1024;
+/** The widest PNG a batch makes. Wider is a poster, made one at a time. */
+export declare const MAX_WIDTH_PX = 8192;
+/** A PDF or EPS code's printed width, as the design's `sizeBasis` measures it, when nothing says otherwise. */
+export declare const DEFAULT_PRINT_SIZE_MM = 30;
+/** For 'sampled': one row in this many is checked, or fewer in a large batch (`MAX_SAMPLES`). */
+export declare const DEFAULT_VERIFY_EVERY = 20;
+/**
+ * For 'sampled' without `verifyEvery`: the most rows checked besides the
+ * longest. At 8 seeds a check is 5 to 16 seconds, so a sample of a 2,000 row
+ * batch stays at a few minutes however large the batch.
+ */
+export declare const MAX_SAMPLES = 10;
+/**
+ * With a verifier and no mode on the output, up to this many rows are
+ * checked in full and a larger batch is not checked. At 2 seeds a row
+ * measured 4 to 5 seconds on a laptop with little else running, so a small
+ * batch's check is done in under half a minute.
+ */
+export declare const SMALL_BATCH = 5;
+/** Seeded captures a level when every row is checked: enough to catch a design that fails outright. */
+export declare const SEEDS_ALL = 2;
+/** Seeded captures a level when a sample is checked: verify's full count, as for a single code. */
+export declare const SEEDS_SAMPLED = 8;
+/** A refusal from a lower layer as an issue on the row, in that layer's own message key. */
+export declare function errorIssue(error: QrStudioError): Issue;
+/**
+ * Make a batch's files. Drive the generator to the end: each step makes one
+ * row (or one step of a row's scan check), and the return value is the ZIP or
+ * the sheet PDF. Everything is checked before the first step, so a mistake
+ * throws here rather than partway through.
+ */
+export declare function runBatch(rows: readonly BatchRow[], design: QrDesignV1, output: BatchOutput, registries: BatchRegistries, options?: RunBatchOptions): Generator<BatchProgress, Uint8Array>;
+//# sourceMappingURL=run.d.ts.map

package/dist/batch/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/batch/run.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,OAAO,EAAE,aAAa,EAAqB,MAAM,mBAAmB,CAAC;AAGrE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAM9C,OAAO,KAAK,EAAiB,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAmBpE,OAAO,KAAK,EAEX,WAAW,EACX,aAAa,EACb,eAAe,EACf,QAAQ,EAIR,eAAe,EACf,MAAM,YAAY,CAAC;AAGpB,8EAA8E;AAC9E,eAAO,MAAM,gBAAgB,OAAO,CAAC;AACrC,2EAA2E;AAC3E,eAAO,MAAM,YAAY,OAAO,CAAC;AAEjC,+GAA+G;AAC/G,eAAO,MAAM,qBAAqB,KAAK,CAAC;AACxC,iGAAiG;AACjG,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC;;;;GAIG;AACH,eAAO,MAAM,WAAW,KAAK,CAAC;AAC9B;;;;;GAKG;AACH,eAAO,MAAM,WAAW,IAAI,CAAC;AAC7B,uGAAuG;AACvG,eAAO,MAAM,SAAS,IAAI,CAAC;AAC3B,mGAAmG;AACnG,eAAO,MAAM,aAAa,IAAI,CAAC;AA4Q/B,4FAA4F;AAC5F,wBAAgB,UAAU,CAAC,KAAK,EAAE,aAAa,GAAG,KAAK,CAatD;AAqSD;;;;;GAKG;AACH,wBAAgB,QAAQ,CACvB,IAAI,EAAE,SAAS,QAAQ,EAAE,EACzB,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,eAAe,EAC3B,OAAO,GAAE,eAAoB,GAC3B,SAAS,CAAC,aAAa,EAAE,UAAU,CAAC,CAEtC"}