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

package/dist/batch/template.js

@@ -0,0 +1,119 @@
+/**
+ * Templates that fill in cells: `https://example.com/p/{sku}` for a field,
+ * `label-{sku}` for a file name.
+ *
+ * `{name}` is the cell in the column called name. `{{` and `}}` are a
+ * literal brace. A brace that starts nothing (`{` with no closing one, or an
+ * empty `{}`) is kept as written, so a template is never refused for its
+ * punctuation; only a name that is not a column is, by the caller.
+ *
+ * In a link, a cell's text has to stay one piece of the link. A product code
+ * of `A/B` dropped raw into a path makes two path segments, and a campaign of
+ * `spring&ref=evil` dropped into a query adds a parameter nobody wrote. So a
+ * value placed after the link's scheme (anything once `https://` has been
+ * written) is percent-encoded as a URL component (`encodeURIComponent`): it
+ * can be a path segment, a query value or a fragment, and it cannot end
+ * either or start another. A value placed before that is supplying the start
+ * of the link itself (`{url}`, or `{site}/p/{sku}`), and goes in as it is,
+ * to be checked as a link like any other.
+ *
+ * Text with an unpaired surrogate cannot be percent-encoded and goes in as it
+ * is too, which the content type's validation then reports as the broken
+ * character it is.
+ */
+import { foldHeader } from './csv.js';
+/** A template's literal text and placeholders, in order. */
+export function parseTemplate(template) {
+    const parts = [];
+    let literal = '';
+    let at = 0;
+    while (at < template.length) {
+        const c = template[at];
+        if ((c === '{' || c === '}') && template[at + 1] === c) {
+            literal += c;
+            at += 2;
+            continue;
+        }
+        if (c === '{') {
+            const close = template.indexOf('}', at + 1);
+            const inner = close === -1 ? '' : template.slice(at + 1, close);
+            if (inner !== '' && !inner.includes('{')) {
+                if (literal !== '')
+                    parts.push({ literal });
+                literal = '';
+                parts.push({ column: inner });
+                at = close + 1;
+                continue;
+            }
+        }
+        literal += c;
+        at += 1;
+    }
+    if (literal !== '')
+        parts.push({ literal });
+    return parts;
+}
+/**
+ * The column a name refers to: the header that is exactly that name, else
+ * the first that matches it ignoring case and surrounding spaces, else -1.
+ * Spreadsheet headers pick up stray spaces, and a template typed by hand
+ * rarely matches their case.
+ */
+export function findColumn(headers, name) {
+    const exact = headers.indexOf(name);
+    if (exact !== -1)
+        return exact;
+    const folded = foldHeader(name);
+    if (folded === '')
+        return -1;
+    return headers.findIndex((header) => foldHeader(header) === folded);
+}
+/** Each placeholder's column, or the name of the first that is not a column. */
+export function compileTemplate(template, headers) {
+    const parts = [];
+    const columns = [];
+    for (const part of parseTemplate(template)) {
+        if ('literal' in part) {
+            parts.push(part);
+            continue;
+        }
+        const index = findColumn(headers, part.column);
+        if (index === -1)
+            return { missing: part.column };
+        parts.push({ index });
+        columns.push(index);
+    }
+    return { parts, columns };
+}
+const SCHEME_WRITTEN = /^[A-Za-z][A-Za-z0-9+.-]*:\/\//;
+function hasLoneSurrogate(text) {
+    for (let i = 0; i < text.length; i += 1) {
+        const code = text.charCodeAt(i);
+        if (code >= 0xd800 && code <= 0xdbff) {
+            const low = text.charCodeAt(i + 1);
+            if (!(low >= 0xdc00 && low <= 0xdfff))
+                return true;
+            i += 1;
+        }
+        else if (code >= 0xdc00 && code <= 0xdfff)
+            return true;
+    }
+    return false;
+}
+/** A compiled template filled in from one row; `url` escapes values placed after the scheme. */
+export function fillTemplate(template, cells, url) {
+    let out = '';
+    for (const part of template.parts) {
+        if ('literal' in part) {
+            out += part.literal;
+            continue;
+        }
+        const value = cells[part.index] ?? '';
+        out +=
+            url && SCHEME_WRITTEN.test(out) && !hasLoneSurrogate(value)
+                ? encodeURIComponent(value)
+                : value;
+    }
+    return out;
+}
+//# sourceMappingURL=template.js.map

package/dist/batch/template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.js","sourceRoot":"","sources":["../../src/batch/template.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAItC,4DAA4D;AAC5D,MAAM,UAAU,aAAa,CAAC,QAAgB;IAC7C,MAAM,KAAK,GAAmB,EAAE,CAAC;IACjC,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,EAAE,GAAG,CAAC,CAAC;IACX,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAW,CAAC;QACjC,IAAI,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC,CAAC;YACb,EAAE,IAAI,CAAC,CAAC;YACR,SAAS;QACV,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YACf,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;YAC5C,MAAM,KAAK,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;YAChE,IAAI,KAAK,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1C,IAAI,OAAO,KAAK,EAAE;oBAAE,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC5C,OAAO,GAAG,EAAE,CAAC;gBACb,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC9B,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC;gBACf,SAAS;YACV,CAAC;QACF,CAAC;QACD,OAAO,IAAI,CAAC,CAAC;QACb,EAAE,IAAI,CAAC,CAAC;IACT,CAAC;IACD,IAAI,OAAO,KAAK,EAAE;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5C,OAAO,KAAK,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,OAA0B,EAAE,IAAY;IAClE,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,KAAK,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/B,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,MAAM,KAAK,EAAE;QAAE,OAAO,CAAC,CAAC,CAAC;IAC7B,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,CAAC;AACrE,CAAC;AASD,gFAAgF;AAChF,MAAM,UAAU,eAAe,CAC9B,QAAgB,EAChB,OAA0B;IAE1B,MAAM,KAAK,GAAwC,EAAE,CAAC;IACtD,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5C,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACvB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,SAAS;QACV,CAAC;QACD,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI,KAAK,KAAK,CAAC,CAAC;YAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC3B,CAAC;AAED,MAAM,cAAc,GAAG,+BAA+B,CAAC;AAEvD,SAAS,gBAAgB,CAAC,IAAY;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACnC,IAAI,CAAC,CAAC,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,MAAM,CAAC;gBAAE,OAAO,IAAI,CAAC;YACnD,CAAC,IAAI,CAAC,CAAC;QACR,CAAC;aAAM,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM;YAAE,OAAO,IAAI,CAAC;IAC1D,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,YAAY,CAC3B,QAA0B,EAC1B,KAAwB,EACxB,GAAY;IAEZ,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACvB,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC;YACpB,SAAS;QACV,CAAC;QACD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACtC,GAAG;YACF,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;gBAC1D,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC;gBAC3B,CAAC,CAAC,KAAK,CAAC;IACX,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC"}

package/dist/batch/text-decoding.d.ts

@@ -0,0 +1,49 @@
+/**
+ * The bytes of a dropped CSV file, as text.
+ *
+ * A spreadsheet saves CSV in whatever its platform calls the default. Excel
+ * on Windows writes "CSV (comma delimited)" in the machine's ANSI code page:
+ * Windows-1252 for English and Western European installs, Shift_JIS for
+ * Japanese, GBK for Simplified Chinese, Big5 for Traditional Chinese, EUC-KR
+ * for Korean, Windows-1251 for Cyrillic and Windows-1256 for Arabic. "CSV
+ * UTF-8" adds a byte order mark; "Unicode Text" is UTF-16 little endian with
+ * one. Google Sheets and Numbers write UTF-8. So:
+ *
+ * 1. A UTF-16 byte order mark (FF FE or FE FF) means UTF-16. Nothing else
+ *    starts that way: neither byte can begin UTF-8, and a Windows-1252 file
+ *    opening with "y" diaeresis and thorn is not a spreadsheet.
+ * 2. Otherwise strict UTF-8, which refuses any byte sequence UTF-8 cannot
+ *    produce. A file in a code page with a letter beyond ASCII in it is
+ *    almost never valid UTF-8 by accident, because a lone byte from 0x80 up
+ *    is not.
+ * 3. Otherwise the fallback the caller chose (Windows-1252 unless it says),
+ *    with a warning that names it, because a file in another code page will
+ *    have come out wrong and the person is the only one who can tell.
+ *
+ * Windows-1252 is the WHATWG Encoding Standard's table, written out here
+ * rather than asked of `TextDecoder`, which has it only in builds with full
+ * ICU. The same goes for UTF-16, which is two lines. UTF-8 is `TextDecoder`'s,
+ * which every engine has. The other fallbacks are `TextDecoder`'s too, and an
+ * engine without one is refused out loud rather than read as something else.
+ */
+import type { CsvFallbackEncoding, DecodeCsvOptions, DecodedText } from './types.js';
+/** What a file that is not UTF-8 may be read as: WHATWG labels, each a spreadsheet's default somewhere. */
+export declare const CSV_FALLBACK_ENCODINGS: readonly CsvFallbackEncoding[];
+/** The fallback when none is given: English and Western European Excel's. */
+export declare const DEFAULT_CSV_FALLBACK: CsvFallbackEncoding;
+export declare function isCsvFallbackEncoding(value: unknown): value is CsvFallbackEncoding;
+/**
+ * A caller's fallback option: the default when it is undefined, and a
+ * TypeError (`${what} one of ...`) when it is not a label this layer reads.
+ */
+export declare function csvFallbackOption(value: unknown, what: string): CsvFallbackEncoding;
+/** Windows-1252, every byte defined. */
+export declare function decodeWindows1252(bytes: Uint8Array): string;
+/**
+ * The text of a CSV file's bytes, the encoding it was read as, and a warning
+ * when that was the fallback. Throws 'platform/unavailable' (params
+ * `{ feature: 'text-encoding', encoding }`) when the fallback is needed and
+ * this engine cannot decode it.
+ */
+export declare function decodeCsvBytes(bytes: Uint8Array, options?: DecodeCsvOptions): DecodedText;
+//# sourceMappingURL=text-decoding.d.ts.map

package/dist/batch/text-decoding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-decoding.d.ts","sourceRoot":"","sources":["../../src/batch/text-decoding.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAMH,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAErF,2GAA2G;AAC3G,eAAO,MAAM,sBAAsB,EAAE,SAAS,mBAAmB,EAQ/D,CAAC;AAEH,6EAA6E;AAC7E,eAAO,MAAM,oBAAoB,EAAE,mBAAoC,CAAC;AAExE,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,mBAAmB,CAElF;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAInF;AAwBD,wCAAwC;AACxC,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAO3D;AAwCD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,GAAE,gBAAqB,GAAG,WAAW,CA2B7F"}

package/dist/batch/text-decoding.js

@@ -0,0 +1,160 @@
+/**
+ * The bytes of a dropped CSV file, as text.
+ *
+ * A spreadsheet saves CSV in whatever its platform calls the default. Excel
+ * on Windows writes "CSV (comma delimited)" in the machine's ANSI code page:
+ * Windows-1252 for English and Western European installs, Shift_JIS for
+ * Japanese, GBK for Simplified Chinese, Big5 for Traditional Chinese, EUC-KR
+ * for Korean, Windows-1251 for Cyrillic and Windows-1256 for Arabic. "CSV
+ * UTF-8" adds a byte order mark; "Unicode Text" is UTF-16 little endian with
+ * one. Google Sheets and Numbers write UTF-8. So:
+ *
+ * 1. A UTF-16 byte order mark (FF FE or FE FF) means UTF-16. Nothing else
+ *    starts that way: neither byte can begin UTF-8, and a Windows-1252 file
+ *    opening with "y" diaeresis and thorn is not a spreadsheet.
+ * 2. Otherwise strict UTF-8, which refuses any byte sequence UTF-8 cannot
+ *    produce. A file in a code page with a letter beyond ASCII in it is
+ *    almost never valid UTF-8 by accident, because a lone byte from 0x80 up
+ *    is not.
+ * 3. Otherwise the fallback the caller chose (Windows-1252 unless it says),
+ *    with a warning that names it, because a file in another code page will
+ *    have come out wrong and the person is the only one who can tell.
+ *
+ * Windows-1252 is the WHATWG Encoding Standard's table, written out here
+ * rather than asked of `TextDecoder`, which has it only in builds with full
+ * ICU. The same goes for UTF-16, which is two lines. UTF-8 is `TextDecoder`'s,
+ * which every engine has. The other fallbacks are `TextDecoder`'s too, and an
+ * engine without one is refused out loud rather than read as something else.
+ */
+import { issue } from '../core/issue.js';
+import { EncodingUnavailableError } from './errors.js';
+import { BATCH_ISSUES } from './issues.js';
+/** What a file that is not UTF-8 may be read as: WHATWG labels, each a spreadsheet's default somewhere. */
+export const CSV_FALLBACK_ENCODINGS = Object.freeze([
+    'windows-1252',
+    'shift_jis',
+    'gb18030',
+    'big5',
+    'euc-kr',
+    'windows-1251',
+    'windows-1256',
+]);
+/** The fallback when none is given: English and Western European Excel's. */
+export const DEFAULT_CSV_FALLBACK = 'windows-1252';
+export function isCsvFallbackEncoding(value) {
+    return CSV_FALLBACK_ENCODINGS.includes(value);
+}
+/**
+ * A caller's fallback option: the default when it is undefined, and a
+ * TypeError (`${what} one of ...`) when it is not a label this layer reads.
+ */
+export function csvFallbackOption(value, what) {
+    if (value === undefined)
+        return DEFAULT_CSV_FALLBACK;
+    if (isCsvFallbackEncoding(value))
+        return value;
+    throw new TypeError(`${what} one of ${CSV_FALLBACK_ENCODINGS.join(', ')}.`);
+}
+/**
+ * Windows-1252 bytes 0x80 to 0x9F, from the WHATWG index. The five bytes the
+ * code page leaves undefined (0x81, 0x8D, 0x8F, 0x90, 0x9D) map to the C1
+ * control of the same number, as the standard says.
+ */
+const WINDOWS_1252_HIGH = [
+    0x20ac, 0x0081, 0x201a, 0x0192, 0x201e, 0x2026, 0x2020, 0x2021, 0x02c6, 0x2030, 0x0160, 0x2039,
+    0x0152, 0x008d, 0x017d, 0x008f, 0x0090, 0x2018, 0x2019, 0x201c, 0x201d, 0x2022, 0x2013, 0x2014,
+    0x02dc, 0x2122, 0x0161, 0x203a, 0x0153, 0x009d, 0x017e, 0x0178,
+];
+/** Code units per `String.fromCharCode` call, well under every engine's argument limit. */
+const CHUNK = 8192;
+function fromUnits(units) {
+    let out = '';
+    for (let i = 0; i < units.length; i += CHUNK) {
+        out += String.fromCharCode(...units.slice(i, i + CHUNK));
+    }
+    return out;
+}
+/** Windows-1252, every byte defined. */
+export function decodeWindows1252(bytes) {
+    const units = new Uint16Array(bytes.length);
+    for (let i = 0; i < bytes.length; i += 1) {
+        const byte = bytes[i];
+        units[i] = byte >= 0x80 && byte <= 0x9f ? WINDOWS_1252_HIGH[byte - 0x80] : byte;
+    }
+    return fromUnits(units);
+}
+/** UTF-16 code units in the given byte order. An unpaired surrogate is kept, for validation to report. */
+function decodeUtf16(bytes, littleEndian) {
+    const units = new Uint16Array(bytes.length >> 1);
+    for (let i = 0; i < units.length; i += 1) {
+        const a = bytes[2 * i];
+        const b = bytes[2 * i + 1];
+        units[i] = littleEndian ? a | (b << 8) : (a << 8) | b;
+    }
+    return fromUnits(units);
+}
+/** Strict UTF-8, or null when the bytes are not UTF-8. A leading byte order mark is dropped. */
+function decodeUtf8(bytes) {
+    try {
+        return new TextDecoder('utf-8', { fatal: true }).decode(bytes);
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * `TextDecoder`'s reading of a code page, or the refusal when this engine has
+ * none. A decoder that answers to the label as another encoding (a polyfill
+ * that knows only UTF-8 does) counts as none: it would read the file wrongly
+ * and say nothing. Bytes the code page has no character for become U+FFFD,
+ * and the fallback's warning already tells the person to check the letters.
+ */
+function decodeCodePage(bytes, label) {
+    let decoder;
+    try {
+        decoder = new TextDecoder(label);
+    }
+    catch {
+        throw new EncodingUnavailableError(label);
+    }
+    if (decoder.encoding !== label)
+        throw new EncodingUnavailableError(label);
+    return decoder.decode(bytes);
+}
+/**
+ * The text of a CSV file's bytes, the encoding it was read as, and a warning
+ * when that was the fallback. Throws 'platform/unavailable' (params
+ * `{ feature: 'text-encoding', encoding }`) when the fallback is needed and
+ * this engine cannot decode it.
+ */
+export function decodeCsvBytes(bytes, options = {}) {
+    if (!(bytes instanceof Uint8Array))
+        throw new TypeError('decodeCsvBytes: bytes is a Uint8Array.');
+    if (typeof options !== 'object' || options === null) {
+        throw new TypeError('decodeCsvBytes: options is an object.');
+    }
+    const fallback = csvFallbackOption(options.fallback, 'decodeCsvBytes: fallback is');
+    const issues = [];
+    const b0 = bytes[0];
+    const b1 = bytes[1];
+    if ((b0 === 0xff && b1 === 0xfe) || (b0 === 0xfe && b1 === 0xff)) {
+        const littleEndian = b0 === 0xff;
+        issues.push(issue(BATCH_ISSUES.utf16, [], 'info'));
+        if (bytes.length % 2 === 1)
+            issues.push(issue(BATCH_ISSUES.oddLength, [], 'warning'));
+        return {
+            text: decodeUtf16(bytes.subarray(2), littleEndian),
+            encoding: littleEndian ? 'utf-16le' : 'utf-16be',
+            issues,
+        };
+    }
+    const utf8 = decodeUtf8(bytes);
+    if (utf8 !== null)
+        return { text: utf8, encoding: 'utf-8', issues };
+    const bom = b0 === 0xef && b1 === 0xbb && bytes[2] === 0xbf ? 3 : 0;
+    const rest = bytes.subarray(bom);
+    const text = fallback === 'windows-1252' ? decodeWindows1252(rest) : decodeCodePage(rest, fallback);
+    issues.push(issue(BATCH_ISSUES.fallbackEncoding, [], 'warning', { encoding: fallback }));
+    return { text, encoding: fallback, issues };
+}
+//# sourceMappingURL=text-decoding.js.map

package/dist/batch/text-decoding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-decoding.js","sourceRoot":"","sources":["../../src/batch/text-decoding.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,2GAA2G;AAC3G,MAAM,CAAC,MAAM,sBAAsB,GAAmC,MAAM,CAAC,MAAM,CAAC;IACnF,cAAc;IACd,WAAW;IACX,SAAS;IACT,MAAM;IACN,QAAQ;IACR,cAAc;IACd,cAAc;CACd,CAAC,CAAC;AAEH,6EAA6E;AAC7E,MAAM,CAAC,MAAM,oBAAoB,GAAwB,cAAc,CAAC;AAExE,MAAM,UAAU,qBAAqB,CAAC,KAAc;IACnD,OAAQ,sBAA6C,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACvE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAc,EAAE,IAAY;IAC7D,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,oBAAoB,CAAC;IACrD,IAAI,qBAAqB,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/C,MAAM,IAAI,SAAS,CAAC,GAAG,IAAI,WAAW,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7E,CAAC;AAED;;;;GAIG;AACH,MAAM,iBAAiB,GAAsB;IAC5C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAC9F,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAC9F,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAC9D,CAAC;AAEF,2FAA2F;AAC3F,MAAM,KAAK,GAAG,IAAI,CAAC;AAEnB,SAAS,SAAS,CAAC,KAA6B;IAC/C,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC;QAC9C,GAAG,IAAI,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,wCAAwC;AACxC,MAAM,UAAU,iBAAiB,CAAC,KAAiB;IAClD,MAAM,KAAK,GAAG,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAW,CAAC;QAChC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,CAAE,iBAAiB,CAAC,IAAI,GAAG,IAAI,CAAY,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7F,CAAC;IACD,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;AACzB,CAAC;AAED,0GAA0G;AAC1G,SAAS,WAAW,CAAC,KAAiB,EAAE,YAAqB;IAC5D,MAAM,KAAK,GAAG,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1C,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAW,CAAC;QACjC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAW,CAAC;QACrC,KAAK,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC;AACzB,CAAC;AAED,gGAAgG;AAChG,SAAS,UAAU,CAAC,KAAiB;IACpC,IAAI,CAAC;QACJ,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,KAAiB,EAAE,KAA0B;IACpE,IAAI,OAAoB,CAAC;IACzB,IAAI,CAAC;QACJ,OAAO,GAAG,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAAC,MAAM,CAAC;QACR,MAAM,IAAI,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,KAAK,KAAK;QAAE,MAAM,IAAI,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAC1E,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,KAAiB,EAAE,UAA4B,EAAE;IAC/E,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC;QAAE,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAC;IAClG,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrD,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;IAC9D,CAAC;IACD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC;IACpF,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACpB,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACpB,IAAI,CAAC,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAClE,MAAM,YAAY,GAAG,EAAE,KAAK,IAAI,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;QACnD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QACtF,OAAO;YACN,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC;YAClD,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU;YAChD,MAAM;SACN,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAC/B,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IACpE,MAAM,GAAG,GAAG,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,IAAI,GACT,QAAQ,KAAK,cAAc,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxF,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,gBAAgB,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IACzF,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;AAC7C,CAAC"}

package/dist/batch/types.d.ts

@@ -0,0 +1,240 @@
+/**
+ * The public shape of the batch layer, as docs/CONTRACTS.md (`batch`) gives
+ * it.
+ *
+ * Additions to the contract, each optional or new so a caller written to the
+ * contract alone still works, and each listed in the branch report:
+ *
+ * - `CsvTable.delimiter`, `rowNumbers` and `issues`: which delimiter was used
+ *   (worth showing when it was sniffed), the spreadsheet row number of each
+ *   data row (blank lines count, as a spreadsheet shows them), and the
+ *   warnings reading the file raised, such as a row with fewer cells than
+ *   the header.
+ * - `BatchRow.rowNumber` and `typeId`. The manifest and the fallback file
+ *   name give the row a person sees in their spreadsheet, not an index; and
+ *   `runBatch` needs the content type for its constraints, which the
+ *   contract's row did not carry.
+ * - `BatchOutput` options beyond the contract's: `dpi`, `colourSpace` and
+ *   `includeContent` for a ZIP, `sizeMm` and `skip` for a sheet, a sheet
+ *   template given as a `SheetTemplate` as well as by id, and the
+ *   verification mode, sample rate and seed count on both. They live on the output rather than in a
+ *   separate argument so the studio's `batch` command carries them as it is.
+ * - `runBatch` takes a fifth argument for what cannot be posted to a worker:
+ *   the per-row verifier, fonts, the seed and the archive date. The verifier
+ *   is passed rather than defaulted so that `run.ts` does not import verify:
+ *   the offline file leaves the scan check out until the studio is given
+ *   one, and a default here would put it back in through the batch command.
+ *   `scanCheckVerifier(registries)` in `verify.ts` is the scan check.
+ * - Each progress event may carry the outcome of the row it follows, which
+ *   is how a sheet run (a PDF, with no manifest inside it) reports skipped
+ *   rows and labels too small for their codes.
+ * - `BatchRegistries` is what batch needs from the root `createRegistries()`
+ *   bag. The root bag satisfies it structurally.
+ */
+import type { RgbaImage } from '../core/image.js';
+import type { Issue } from '../core/issue.js';
+import type { Registry } from '../core/registry.js';
+import type { DesignOverlay, DesignRegistries, QrDesignV1 } from '../design/types.js';
+import type { PayloadRegistry } from '../payload/registry.js';
+import type { SheetTemplate } from '../render/impose.js';
+import type { SymbologyEntry } from '../symbology/types.js';
+import type { FontRegistry } from '../text/types.js';
+export type CsvDelimiter = ',' | ';' | '\t';
+export interface CsvTable {
+    readonly headers: readonly string[];
+    /** Every row has exactly as many cells as there are headers: short rows are padded, with an issue. */
+    readonly rows: readonly (readonly string[])[];
+    /** The delimiter the file was read with. A contract addition. */
+    readonly delimiter: CsvDelimiter;
+    /** The spreadsheet row number of each data row; the header is row 1. A contract addition. */
+    readonly rowNumbers: readonly number[];
+    /** Warnings from reading: ragged rows, duplicate headers. Path `['rows', index]` or `['headers', index]`. A contract addition. */
+    readonly issues: readonly Issue[];
+}
+export interface ParseCsvOptions {
+    /** Default 'auto': sniffed from the first rows, or from an Excel `sep=` line. */
+    readonly delimiter?: CsvDelimiter | 'auto';
+    /** Data rows, the header not counted. Default 10,000. */
+    readonly maxRows?: number;
+}
+/**
+ * What a CSV that is not UTF-8 is read as: the WHATWG label of a code page a
+ * spreadsheet writes CSV in by default somewhere. Windows-1252 for English and
+ * Western European Excel, Shift_JIS for Japanese, GB18030 (which reads GBK) for
+ * Simplified Chinese, Big5 for Traditional Chinese, EUC-KR for Korean,
+ * Windows-1251 for Cyrillic and Windows-1256 for Arabic.
+ */
+export type CsvFallbackEncoding = 'windows-1252' | 'shift_jis' | 'gb18030' | 'big5' | 'euc-kr' | 'windows-1251' | 'windows-1256';
+export type TextEncodingName = 'utf-8' | 'utf-16le' | 'utf-16be' | CsvFallbackEncoding;
+export interface DecodeCsvOptions {
+    /**
+     * What to read the bytes as when they have no UTF-16 byte order mark and are
+     * not UTF-8. Default 'windows-1252'.
+     */
+    readonly fallback?: CsvFallbackEncoding;
+}
+export interface DecodedText {
+    readonly text: string;
+    readonly encoding: TextEncodingName;
+    readonly issues: readonly Issue[];
+}
+/** Where one content field's value comes from. */
+export type FieldSource = {
+    readonly column: string;
+} | {
+    readonly template: string;
+};
+export interface BatchMapping {
+    readonly typeId: string;
+    /** Each field from a column, or from a template such as `https://example.com/t/{id}`. */
+    readonly fields: Readonly<Record<string, FieldSource>>;
+    /** A template such as `label-{sku}`; sanitised, and duplicates numbered `-2`, `-3`. */
+    readonly filename: string;
+}
+export interface BatchRow {
+    /** The row's index in `CsvTable.rows`. */
+    readonly index: number;
+    /** The row number a spreadsheet shows for it; the header is row 1. A contract addition. */
+    readonly rowNumber: number;
+    /** The content type every field was validated by. A contract addition. */
+    readonly typeId: string;
+    /** A safe, unique file name without its extension, which `runBatch` adds. */
+    readonly filename: string;
+    /** The text of the code, or null when the row has error issues. */
+    readonly content: string | null;
+    readonly issues: readonly Issue[];
+}
+/** The parts of the root registries bag that batch uses. */
+export interface BatchRegistries {
+    readonly symbologies: Registry<SymbologyEntry>;
+    readonly payloads: PayloadRegistry;
+    readonly design: DesignRegistries;
+}
+/**
+ * Which rows the scan check runs on. 'sampled' checks every Nth row written
+ * (`verifyEvery`) and the row with the longest content, which makes the
+ * densest code. When the output gives none, a batch of up to 5 rows
+ * (`SMALL_BATCH`) is checked in full and a larger one not at all.
+ */
+export type BatchVerifyMode = 'off' | 'sampled' | 'all';
+interface BatchOutputOptions {
+    readonly verify?: BatchVerifyMode;
+    /**
+     * For 'sampled': check every this-many rows written. A whole number from
+     * 1. Default 20, or more in a large batch so that at most 10 rows and the
+     * longest are checked.
+     */
+    readonly verifyEvery?: number;
+    /** Seeded captures a level, 1 to 8. Default 2 for 'all' and 8, verify's full count, for 'sampled'. */
+    readonly verifySeeds?: number;
+}
+export interface BatchZipOutput extends BatchOutputOptions {
+    readonly kind: 'zip';
+    readonly format: 'svg' | 'png' | 'pdf' | 'eps';
+    /** PNG: the whole artwork's width in pixels. Defaults to the print size at the resolution, else 1024. */
+    readonly widthPx?: number;
+    /** PNG: pixels per inch, written into the file. Defaults to the design's. */
+    readonly dpi?: number;
+    /**
+     * Printed width of each code, measured as the design's `sizeBasis` says
+     * (the whole artwork unless the design says the symbol). Defaults to the
+     * design's, else 30 for PDF and EPS.
+     */
+    readonly sizeMm?: number;
+    /** PDF and EPS. Defaults to the design's. */
+    readonly colourSpace?: 'srgb' | 'cmyk';
+    /** Write each row's content into the manifest. Default false: a manifest is shared more widely than codes are. */
+    readonly includeContent?: boolean;
+}
+export interface BatchSheetOutput extends BatchOutputOptions {
+    readonly kind: 'sheet';
+    /** A built-in template's id (`builtInSheets`), or a template of the caller's own. */
+    readonly template: string | SheetTemplate;
+    readonly colourSpace: 'srgb' | 'cmyk';
+    /**
+     * Printed width of each code, measured as the design's `sizeBasis` says.
+     * Defaults to the design's. With neither, each code is scaled to fill its
+     * label.
+     */
+    readonly sizeMm?: number;
+    /** Labels on the first sheet already used. Default 0. */
+    readonly skip?: number;
+}
+export type BatchOutput = BatchZipOutput | BatchSheetOutput;
+/** What a verifier is asked to check: one row's content in the design it was drawn with. */
+export interface BatchVerifyRequest {
+    readonly index: number;
+    readonly rowNumber: number;
+    readonly content: string;
+    /** The design after the content type's constraints, exactly as the file was drawn. */
+    readonly design: QrDesignV1;
+    /** What the content type draws over its code whatever the design: the Swiss QR-bill's cross. */
+    readonly overlay: DesignOverlay | null;
+    /**
+     * Printed width of the symbol with its quiet zone, worked out from the
+     * scene as drawn, when the output has a size. Not the design's own
+     * `sizeMm`, which may measure the whole artwork.
+     */
+    readonly sizeMm: number | null;
+    /** Pixels per inch, for a PNG. */
+    readonly dpi: number | null;
+    readonly seed: number;
+    /** Seeded captures a level, 1 to 8, chosen by the mode or `verifySeeds`. */
+    readonly captureSeeds: number;
+    /** The design's embedded pictures, decoded, which a check draws the design with. */
+    readonly assets: Readonly<Record<string, RgbaImage>>;
+}
+export interface BatchVerifyResult {
+    readonly verdict: 'pass' | 'warn' | 'fail';
+    /** Anything more to say about this row; added to its issues. */
+    readonly issues?: readonly Issue[];
+}
+/**
+ * Checks one row. May return the result, or an iterator to drive one step at
+ * a time (verify's own generator), so a long check is time-sliced with the
+ * rest of the batch rather than run in one go.
+ */
+export type BatchVerifier = (request: BatchVerifyRequest) => BatchVerifyResult | Iterator<unknown, BatchVerifyResult>;
+export interface RunBatchOptions {
+    /**
+     * The check for one row. `scanCheckVerifier(registries)` is the scan
+     * check, stepped one capture a slice. Without one, rows are not checked.
+     */
+    readonly verifyRow?: BatchVerifier;
+    /** Fonts for frame captions. Default: the built-in family. */
+    readonly fonts?: FontRegistry;
+    /** The design's seed for anything random-looking, the same for every row. Default 0. */
+    readonly seed?: number;
+    /** The date every ZIP entry carries. Default 1980-01-01, as core's writer. */
+    readonly date?: {
+        readonly year: number;
+        readonly month: number;
+        readonly day: number;
+    };
+}
+export type BatchStatus = 'written' | 'skipped';
+/** What happened to one row. */
+export interface BatchOutcome {
+    readonly index: number;
+    readonly rowNumber: number;
+    readonly typeId: string;
+    /** The entry's name in the ZIP, extension included; null for a skipped row or a sheet. */
+    readonly filename: string | null;
+    readonly status: BatchStatus;
+    /** The scan check's verdict, or null when the row was not checked. */
+    readonly check: 'pass' | 'warn' | 'fail' | null;
+    /** Where the code went on a sheet: 1-based page and label, in reading order. */
+    readonly sheet: {
+        readonly page: number;
+        readonly label: number;
+    } | null;
+    readonly issues: readonly Issue[];
+}
+export interface BatchProgress {
+    readonly done: number;
+    readonly total: number;
+    /** The row just finished. Absent for steps within a row and for writing the file. A contract addition. */
+    readonly row?: BatchOutcome;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/batch/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACtF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,MAAM,MAAM,YAAY,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC;AAE5C,MAAM,WAAW,QAAQ;IACxB,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,sGAAsG;IACtG,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC;IAC9C,iEAAiE;IACjE,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,6FAA6F;IAC7F,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC,kIAAkI;IAClI,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,eAAe;IAC/B,iFAAiF;IACjF,QAAQ,CAAC,SAAS,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IAC3C,yDAAyD;IACzD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAC9B,cAAc,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,cAAc,GAAG,cAAc,CAAC;AAEhG,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,GAAG,mBAAmB,CAAC;AAEvF,MAAM,WAAW,gBAAgB;IAChC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CACxC;AAED,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;CAClC;AAED,kDAAkD;AAClD,MAAM,MAAM,WAAW,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtF,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,yFAAyF;IACzF,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IACvD,uFAAuF;IACvF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,QAAQ;IACxB,0CAA0C;IAC1C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,2FAA2F;IAC3F,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,0EAA0E;IAC1E,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,mEAAmE;IACnE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;CAClC;AAED,4DAA4D;AAC5D,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC/C,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;CAClC;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC;AAExD,UAAU,kBAAkB;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAClC;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,sGAAsG;IACtG,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACzD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;IAC/C,yGAAyG;IACzG,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,6EAA6E;IAC7E,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,kHAAkH;IAClH,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;CAClC;AAED,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC3D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,qFAAqF;IACrF,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa,CAAC;IAC1C,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IACtC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE5D,4FAA4F;AAC5F,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,sFAAsF;IACtF,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,gGAAgG;IAChG,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IACvC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,kCAAkC;IAClC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,oFAAoF;IACpF,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,iBAAiB;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC3C,gEAAgE;IAChE,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,KAAK,EAAE,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,CAC3B,OAAO,EAAE,kBAAkB,KACvB,iBAAiB,GAAG,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;AAE9D,MAAM,WAAW,eAAe;IAC/B;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC;IACnC,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC;IAC9B,wFAAwF;IACxF,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,8EAA8E;IAC9E,QAAQ,CAAC,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CACxF;AAED,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,SAAS,CAAC;AAEhD,gCAAgC;AAChC,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,0FAA0F;IAC1F,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,sEAAsE;IACtE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAChD,gFAAgF;IAChF,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACzE,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,0GAA0G;IAC1G,QAAQ,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC;CAC5B"}

package/dist/batch/types.js

@@ -0,0 +1,35 @@
+/**
+ * The public shape of the batch layer, as docs/CONTRACTS.md (`batch`) gives
+ * it.
+ *
+ * Additions to the contract, each optional or new so a caller written to the
+ * contract alone still works, and each listed in the branch report:
+ *
+ * - `CsvTable.delimiter`, `rowNumbers` and `issues`: which delimiter was used
+ *   (worth showing when it was sniffed), the spreadsheet row number of each
+ *   data row (blank lines count, as a spreadsheet shows them), and the
+ *   warnings reading the file raised, such as a row with fewer cells than
+ *   the header.
+ * - `BatchRow.rowNumber` and `typeId`. The manifest and the fallback file
+ *   name give the row a person sees in their spreadsheet, not an index; and
+ *   `runBatch` needs the content type for its constraints, which the
+ *   contract's row did not carry.
+ * - `BatchOutput` options beyond the contract's: `dpi`, `colourSpace` and
+ *   `includeContent` for a ZIP, `sizeMm` and `skip` for a sheet, a sheet
+ *   template given as a `SheetTemplate` as well as by id, and the
+ *   verification mode, sample rate and seed count on both. They live on the output rather than in a
+ *   separate argument so the studio's `batch` command carries them as it is.
+ * - `runBatch` takes a fifth argument for what cannot be posted to a worker:
+ *   the per-row verifier, fonts, the seed and the archive date. The verifier
+ *   is passed rather than defaulted so that `run.ts` does not import verify:
+ *   the offline file leaves the scan check out until the studio is given
+ *   one, and a default here would put it back in through the batch command.
+ *   `scanCheckVerifier(registries)` in `verify.ts` is the scan check.
+ * - Each progress event may carry the outcome of the row it follows, which
+ *   is how a sheet run (a PDF, with no manifest inside it) reports skipped
+ *   rows and labels too small for their codes.
+ * - `BatchRegistries` is what batch needs from the root `createRegistries()`
+ *   bag. The root bag satisfies it structurally.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/batch/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/batch/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG"}