@qvac/harness 0.7.2 → 0.8.0

package/dist-lib/lib/office/engine/xlsx/strings.js

@@ -0,0 +1,93 @@
+import * as xml from '../xml.js';
+const X = xml.ns.x;
+const TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml';
+const REL = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings';
+const XML_NS = 'http://www.w3.org/XML/1998/namespace';
+const ESCAPE = /_x([0-9A-Fa-f]{4})_/g;
+const LITERAL = /_(?=x[0-9A-Fa-f]{4}_)/g;
+const UNWRITABLE = /[\u0000-\u0008\u000B-\u001F\uFFFE\uFFFF]|[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?<![\uD800-\uDBFF])[\uDC00-\uDFFF]/g;
+function decodeText(text) {
+    return text.replace(ESCAPE, (_, hex) => String.fromCharCode(parseInt(hex, 16)));
+}
+function encodeText(text) {
+    return text
+        .replace(LITERAL, '_x005F_')
+        .replace(UNWRITABLE, (ch) => `_x${ch.charCodeAt(0).toString(16).toUpperCase().padStart(4, '0')}_`);
+}
+export function runText(container) {
+    const t = xml.child(container, X, 't');
+    if (t) {
+        return decodeText(xml.text(t));
+    }
+    return xml
+        .children(container, X, 'r')
+        .map((r) => decodeText(xml.text(xml.child(r, X, 't'))))
+        .join('');
+}
+export class SharedStrings {
+    package;
+    workbookPart;
+    part;
+    items;
+    index;
+    constructor(pkg, workbookPart) {
+        this.package = pkg;
+        this.workbookPart = workbookPart;
+        this.part = pkg.related(workbookPart, REL)[0] ?? null;
+        this.items = null;
+        this.index = new Map();
+    }
+    get(i) {
+        return this.load()[i] ?? null;
+    }
+    add(value) {
+        const items = this.load();
+        const known = this.index.get(value);
+        if (known !== undefined) {
+            return known;
+        }
+        const part = this.ensurePart();
+        const doc = this.package.xml(part);
+        const top = xml.root(doc);
+        const si = xml.named(doc, 'si', X);
+        const t = xml.append(si, xml.named(doc, 't', X));
+        if (/^\s|\s$/.test(value)) {
+            t.setAttributeNS(XML_NS, 'xml:space', 'preserve');
+        }
+        t.appendChild(doc.createTextNode(encodeText(value)));
+        top.appendChild(si);
+        const i = items.length;
+        items.push(value);
+        this.index.set(value, i);
+        top.setAttribute('uniqueCount', String(items.length));
+        top.removeAttribute('count');
+        this.package.touch(part);
+        return i;
+    }
+    ensurePart() {
+        if (this.part)
+            return this.part;
+        const part = '/xl/sharedStrings.xml';
+        this.package.add(part, xml.parse(`<sst xmlns="${X}"/>`), TYPE);
+        this.package.rels(this.workbookPart).add(REL, part);
+        this.part = part;
+        return part;
+    }
+    load() {
+        if (this.items)
+            return this.items;
+        const items = [];
+        this.items = items;
+        if (!this.part) {
+            return items;
+        }
+        for (const si of xml.children(this.package.root(this.part), X, 'si')) {
+            const value = runText(si);
+            if (!this.index.has(value)) {
+                this.index.set(value, items.length);
+            }
+            items.push(value);
+        }
+        return items;
+    }
+}

package/dist-lib/lib/office/engine/xlsx/styles.d.ts

@@ -0,0 +1,38 @@
+import type { Document } from '../xml.ts';
+import type { Package } from '../opc/package.ts';
+export type CellAlign = 'left' | 'center' | 'right' | 'justify';
+export interface CellStyle {
+    format?: string;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    color?: string;
+    fill?: string;
+    size?: number;
+    font?: string;
+    align?: CellAlign;
+    wrap?: boolean;
+}
+export declare function isDateCode(code: string): boolean;
+export declare function validate(style: unknown): CellStyle;
+export declare class Styles {
+    package: Package;
+    workbookPart: string;
+    part: string | null;
+    constructor(pkg: Package, workbookPart: string);
+    get doc(): Document;
+    formatCode(xfIndex: number): string;
+    isDate(xfIndex: number): boolean;
+    derive(xfIndex: number, input: unknown): number;
+    private applyTo;
+    private align;
+    private ensurePart;
+    private touch;
+    private xfs;
+    private list;
+    private code;
+    private formatId;
+    private font;
+    private fill;
+    private dedupe;
+}

package/dist-lib/lib/office/engine/xlsx/styles.js

@@ -0,0 +1,369 @@
+import * as xml from '../xml.js';
+import { DocsError } from '../errors.js';
+import { isRecord } from '../../../guards.js';
+const X = xml.ns.x;
+const TYPE = 'application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml';
+const REL = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles';
+const KNOWN = [
+    'format',
+    'bold',
+    'italic',
+    'underline',
+    'color',
+    'fill',
+    'size',
+    'font',
+    'align',
+    'wrap'
+];
+const TOGGLES = ['bold', 'italic', 'underline', 'wrap'];
+const COLORS = ['color', 'fill'];
+const FONT_KEYS = ['bold', 'italic', 'underline', 'color', 'size', 'font'];
+const ALIGN = {
+    left: 'left',
+    center: 'center',
+    right: 'right',
+    justify: 'justify'
+};
+const BUILTIN = new Map([
+    [0, 'General'],
+    [1, '0'],
+    [2, '0.00'],
+    [3, '#,##0'],
+    [4, '#,##0.00'],
+    [9, '0%'],
+    [10, '0.00%'],
+    [11, '0.00E+00'],
+    [12, '# ?/?'],
+    [13, '# ??/??'],
+    [14, 'mm-dd-yy'],
+    [15, 'd-mmm-yy'],
+    [16, 'd-mmm'],
+    [17, 'mmm-yy'],
+    [18, 'h:mm AM/PM'],
+    [19, 'h:mm:ss AM/PM'],
+    [20, 'h:mm'],
+    [21, 'h:mm:ss'],
+    [22, 'm/d/yy h:mm'],
+    [37, '#,##0 ;(#,##0)'],
+    [38, '#,##0 ;[Red](#,##0)'],
+    [39, '#,##0.00;(#,##0.00)'],
+    [40, '#,##0.00;[Red](#,##0.00)'],
+    [45, 'mm:ss'],
+    [46, '[h]:mm:ss'],
+    [47, 'mmss.0'],
+    [48, '##0.0E+0'],
+    [49, '@']
+]);
+const DATE_IDS = new Set([14, 15, 16, 17, 18, 19, 20, 21, 22, 45, 46, 47]);
+const STYLE_ORDER = [
+    'numFmts',
+    'fonts',
+    'fills',
+    'borders',
+    'cellStyleXfs',
+    'cellXfs',
+    'cellStyles',
+    'dxfs',
+    'tableStyles',
+    'colors',
+    'extLst'
+];
+const FONT_ORDER = [
+    'b',
+    'i',
+    'strike',
+    'condense',
+    'extend',
+    'outline',
+    'shadow',
+    'u',
+    'vertAlign',
+    'sz',
+    'color',
+    'name',
+    'family',
+    'charset',
+    'scheme'
+];
+const DEFAULT = `<styleSheet xmlns="${X}"><fonts count="1"><font><sz val="11"/><name val="Calibri"/><family val="2"/></font></fonts><fills count="2"><fill><patternFill patternType="none"/></fill><fill><patternFill patternType="gray125"/></fill></fills><borders count="1"><border><left/><right/><top/><bottom/><diagonal/></border></borders><cellStyleXfs count="1"><xf numFmtId="0" fontId="0" fillId="0" borderId="0"/></cellStyleXfs><cellXfs count="1"><xf numFmtId="0" fontId="0" fillId="0" borderId="0" xfId="0"/></cellXfs><cellStyles count="1"><cellStyle name="Normal" xfId="0" builtinId="0"/></cellStyles></styleSheet>`;
+export function isDateCode(code) {
+    const stripped = code
+        .replace(/"[^"]*"/g, '')
+        .replace(/\\./g, '')
+        .replace(/\[(?!h\]|m\]|s\])[^\]]*\]/gi, '');
+    if (/^general$/i.test(stripped.trim())) {
+        return false;
+    }
+    return /[dmyhs]/i.test(stripped.split(';')[0]);
+}
+function isAlign(value) {
+    return typeof value === 'string' && value in ALIGN;
+}
+function checkValues(style) {
+    const { format, size, font, align } = style;
+    if (format !== undefined && !(typeof format === 'string' && format.length <= 255)) {
+        throw new DocsError('INVALID_STYLE', 'format must be a number format like "0.00" or "yyyy-mm-dd"');
+    }
+    const toggle = TOGGLES.find((key) => style[key] !== undefined && typeof style[key] !== 'boolean');
+    if (toggle) {
+        throw new DocsError('INVALID_STYLE', `${toggle} must be true or false`);
+    }
+    for (const key of COLORS) {
+        const value = style[key];
+        if (value !== undefined && !(typeof value === 'string' && /^#?[0-9a-fA-F]{6}$/.test(value))) {
+            throw new DocsError('INVALID_STYLE', `${key} must be a hex RGB value like "1A73E8", got ${String(value)}`);
+        }
+    }
+    if (size !== undefined && !(typeof size === 'number' && size >= 1 && size <= 409)) {
+        throw new DocsError('INVALID_STYLE', `size is in points, from 1 to 409, got ${String(size)}`);
+    }
+    if (font !== undefined && !(typeof font === 'string' && font.trim())) {
+        throw new DocsError('INVALID_STYLE', 'font must be a typeface name');
+    }
+    if (align !== undefined && !isAlign(align)) {
+        throw new DocsError('INVALID_STYLE', `align must be left, center, right or justify, got ${String(align)}`);
+    }
+}
+function str(value) {
+    return typeof value === 'string' ? value : undefined;
+}
+function bool(value) {
+    return typeof value === 'boolean' ? value : undefined;
+}
+export function validate(style) {
+    if (!isRecord(style) || Array.isArray(style)) {
+        throw new DocsError('INVALID_STYLE', 'style must be an object');
+    }
+    const unknownKey = Object.keys(style).find((key) => !KNOWN.includes(key));
+    if (unknownKey) {
+        throw new DocsError('INVALID_STYLE', `unknown cell style "${unknownKey}"; use ${KNOWN.join(', ')}`);
+    }
+    checkValues(style);
+    return {
+        format: str(style.format),
+        bold: bool(style.bold),
+        italic: bool(style.italic),
+        underline: bool(style.underline),
+        color: str(style.color),
+        fill: str(style.fill),
+        size: typeof style.size === 'number' ? style.size : undefined,
+        font: str(style.font),
+        align: isAlign(style.align) ? style.align : undefined,
+        wrap: bool(style.wrap)
+    };
+}
+function argb(color) {
+    return 'FF' + color.replace('#', '').toUpperCase();
+}
+function setFontChild(font, local, attributes) {
+    const doc = xml.owner(font);
+    const el = xml.child(font, X, local) ?? xml.insertOrdered(font, xml.named(doc, local, X), FONT_ORDER);
+    for (const attr of Array.from(el.attributes)) {
+        el.removeAttribute(attr.name);
+    }
+    xml.setAttributes(el, attributes);
+}
+function dropFontChild(font, local) {
+    for (const el of xml.children(font, X, local)) {
+        xml.remove(el);
+    }
+}
+function toggleFont(font, local, on) {
+    if (on === undefined)
+        return;
+    if (on) {
+        setFontChild(font, local, {});
+    }
+    else {
+        dropFontChild(font, local);
+    }
+}
+function editFont(font, style) {
+    toggleFont(font, 'b', style.bold);
+    toggleFont(font, 'i', style.italic);
+    toggleFont(font, 'u', style.underline);
+    if (style.size !== undefined) {
+        setFontChild(font, 'sz', { val: style.size });
+    }
+    if (style.color !== undefined) {
+        setFontChild(font, 'color', { rgb: argb(style.color) });
+    }
+    if (style.font !== undefined) {
+        setFontChild(font, 'name', { val: style.font });
+        dropFontChild(font, 'scheme');
+    }
+}
+export class Styles {
+    package;
+    workbookPart;
+    part;
+    constructor(pkg, workbookPart) {
+        this.package = pkg;
+        this.workbookPart = workbookPart;
+        this.part = pkg.related(workbookPart, REL)[0] ?? null;
+    }
+    get doc() {
+        return this.package.xml(this.ensurePart());
+    }
+    formatCode(xfIndex) {
+        if (!this.part)
+            return 'General';
+        const xf = this.xfs()[xfIndex || 0];
+        return this.code(xf ? Number(xf.getAttribute('numFmtId') || 0) : 0);
+    }
+    isDate(xfIndex) {
+        if (!this.part || !xfIndex)
+            return false;
+        const xf = this.xfs()[xfIndex];
+        if (!xf) {
+            return false;
+        }
+        const id = Number(xf.getAttribute('numFmtId') || 0);
+        if (DATE_IDS.has(id)) {
+            return true;
+        }
+        return id >= 164 && isDateCode(this.code(id));
+    }
+    derive(xfIndex, input) {
+        const style = validate(input);
+        const doc = this.doc;
+        const xfs = this.xfs();
+        const base = xfs[xfIndex || 0] ?? xfs[0];
+        const xf = base
+            ? xml.clone(base)
+            : xml.setAttributes(xml.named(doc, 'xf', X), {
+                numFmtId: 0,
+                fontId: 0,
+                fillId: 0,
+                borderId: 0,
+                xfId: 0
+            });
+        this.applyTo(xf, style);
+        const key = xf.toString();
+        const existing = xfs.findIndex((el) => el.toString() === key);
+        if (existing !== -1) {
+            return existing;
+        }
+        const list = this.list('cellXfs');
+        list.appendChild(xf);
+        const count = xml.children(list, X, 'xf').length;
+        list.setAttribute('count', String(count));
+        this.touch();
+        return count - 1;
+    }
+    applyTo(xf, style) {
+        if (style.format !== undefined) {
+            xf.setAttribute('numFmtId', String(this.formatId(style.format)));
+            xf.setAttribute('applyNumberFormat', '1');
+        }
+        if (FONT_KEYS.some((k) => style[k] !== undefined)) {
+            xf.setAttribute('fontId', String(this.font(Number(xf.getAttribute('fontId') || 0), style)));
+            xf.setAttribute('applyFont', '1');
+        }
+        if (style.fill !== undefined) {
+            xf.setAttribute('fillId', String(this.fill(style.fill)));
+            xf.setAttribute('applyFill', '1');
+        }
+        if (style.align !== undefined || style.wrap !== undefined) {
+            this.align(xf, style);
+        }
+    }
+    align(xf, style) {
+        const doc = xml.owner(xf);
+        let alignment = xml.child(xf, X, 'alignment');
+        if (!alignment) {
+            alignment = xml.named(doc, 'alignment', X);
+            xf.insertBefore(alignment, xf.firstChild);
+        }
+        if (style.align !== undefined) {
+            alignment.setAttribute('horizontal', ALIGN[style.align]);
+        }
+        if (style.wrap !== undefined) {
+            alignment.setAttribute('wrapText', style.wrap ? '1' : '0');
+        }
+        xf.setAttribute('applyAlignment', '1');
+    }
+    ensurePart() {
+        if (this.part)
+            return this.part;
+        const part = '/xl/styles.xml';
+        this.package.add(part, xml.parse(DEFAULT), TYPE);
+        this.package.rels(this.workbookPart).add(REL, part);
+        this.part = part;
+        return part;
+    }
+    touch() {
+        this.package.touch(this.ensurePart());
+    }
+    xfs() {
+        const list = xml.child(xml.root(this.doc), X, 'cellXfs');
+        return list ? xml.children(list, X, 'xf') : [];
+    }
+    list(local) {
+        const doc = this.doc;
+        const top = xml.root(doc);
+        const existing = xml.child(top, X, local);
+        if (existing) {
+            return existing;
+        }
+        return xml.insertOrdered(top, xml.setAttributes(xml.named(doc, local, X), { count: 0 }), STYLE_ORDER);
+    }
+    code(id) {
+        const builtin = BUILTIN.get(id);
+        if (builtin !== undefined) {
+            return builtin;
+        }
+        const list = xml.child(xml.root(this.doc), X, 'numFmts');
+        const el = list
+            ? xml.children(list, X, 'numFmt').find((n) => Number(n.getAttribute('numFmtId')) === id)
+            : undefined;
+        return el?.getAttribute('formatCode') || 'General';
+    }
+    formatId(code) {
+        for (const [id, value] of BUILTIN) {
+            if (value === code)
+                return id;
+        }
+        const list = this.list('numFmts');
+        const existing = xml.children(list, X, 'numFmt');
+        const match = existing.find((n) => n.getAttribute('formatCode') === code);
+        if (match) {
+            return Number(match.getAttribute('numFmtId'));
+        }
+        const id = Math.max(163, ...existing.map((n) => Number(n.getAttribute('numFmtId')))) + 1;
+        list.appendChild(xml.setAttributes(xml.named(this.doc, 'numFmt', X), { numFmtId: id, formatCode: code }));
+        list.setAttribute('count', String(existing.length + 1));
+        this.touch();
+        return id;
+    }
+    font(baseId, style) {
+        const list = this.list('fonts');
+        const fonts = xml.children(list, X, 'font');
+        const base = fonts[baseId];
+        const font = base ? xml.clone(base) : xml.named(this.doc, 'font', X);
+        editFont(font, style);
+        return this.dedupe(list, { el: font, siblings: fonts });
+    }
+    fill(color) {
+        const doc = this.doc;
+        const list = this.list('fills');
+        const fills = xml.children(list, X, 'fill');
+        const fill = xml.named(doc, 'fill', X);
+        const pattern = xml.append(fill, xml.setAttributes(xml.named(doc, 'patternFill', X), { patternType: 'solid' }));
+        pattern.appendChild(xml.setAttributes(xml.named(doc, 'fgColor', X), { rgb: argb(color) }));
+        pattern.appendChild(xml.setAttributes(xml.named(doc, 'bgColor', X), { indexed: 64 }));
+        return this.dedupe(list, { el: fill, siblings: fills });
+    }
+    dedupe(list, entry) {
+        const key = entry.el.toString();
+        const existing = entry.siblings.findIndex((el) => el.toString() === key);
+        if (existing !== -1) {
+            return existing;
+        }
+        list.appendChild(entry.el);
+        list.setAttribute('count', String(entry.siblings.length + 1));
+        this.touch();
+        return entry.siblings.length;
+    }
+}

package/dist-lib/lib/office/engine/xlsx/template.d.ts

@@ -0,0 +1,7 @@
+import type { Package } from '../opc/package.ts';
+export interface CreateOptions {
+    sheets?: string[];
+    title?: string;
+    strict?: boolean;
+}
+export declare function build(pkg: Package, opts?: CreateOptions): void;

package/dist-lib/lib/office/engine/xlsx/template.js

@@ -0,0 +1,54 @@
+import * as xml from '../xml.js';
+import { DocsError } from '../errors.js';
+const { x: X, r: R } = xml.ns;
+const REL_BASE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/';
+const SML = 'application/vnd.openxmlformats-officedocument.spreadsheetml.';
+const CORE_REL = 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties';
+function escape(value) {
+    return value
+        .replace(/&/g, '&')
+        .replace(/</g, '&lt;')
+        .replace(/>/g, '&gt;')
+        .replace(/"/g, '&quot;');
+}
+function sheetNames(input) {
+    const names = input === undefined ? ['Sheet1'] : input;
+    if (!Array.isArray(names) || names.length === 0) {
+        throw new DocsError('INVALID_OPTIONS', 'sheets must be a non-empty array of sheet names');
+    }
+    const seen = new Set();
+    return names.map((name) => {
+        if (typeof name !== 'string' ||
+            name.length < 1 ||
+            name.length > 31 ||
+            /[:\\/?*[\]]/.test(name)) {
+            throw new DocsError('INVALID_NAME', `"${String(name)}" is not a valid sheet name`);
+        }
+        if (seen.has(name.toLowerCase())) {
+            throw new DocsError('INVALID_NAME', `the sheet name "${name}" is repeated`);
+        }
+        seen.add(name.toLowerCase());
+        return name;
+    });
+}
+function addSheets(pkg, names) {
+    const sheets = names
+        .map((name, i) => `<sheet name="${escape(name)}" sheetId="${i + 1}" r:id="rId${i + 1}"/>`)
+        .join('');
+    pkg.add('/xl/workbook.xml', xml.parse(`<workbook xmlns="${X}" xmlns:r="${R}"><workbookPr/><bookViews><workbookView activeTab="0"/></bookViews><sheets>${sheets}</sheets><calcPr calcId="191029"/></workbook>`), SML + 'sheet.main+xml');
+    names.forEach((_, i) => {
+        const part = `/xl/worksheets/sheet${i + 1}.xml`;
+        const selected = i === 0 ? ' tabSelected="1"' : '';
+        pkg.add(part, xml.parse(`<worksheet xmlns="${X}" xmlns:r="${R}"><sheetViews><sheetView workbookViewId="0"${selected}/></sheetViews><sheetFormatPr defaultRowHeight="15"/><sheetData/><pageMargins left="0.7" right="0.7" top="0.75" bottom="0.75" header="0.3" footer="0.3"/></worksheet>`), SML + 'worksheet+xml');
+        pkg.rels('/xl/workbook.xml').add(REL_BASE + 'worksheet', part);
+    });
+}
+export function build(pkg, opts = {}) {
+    addSheets(pkg, sheetNames(opts.sheets));
+    const title = typeof opts.title === 'string' && opts.title ? `<dc:title>${escape(opts.title)}</dc:title>` : '';
+    pkg.add('/docProps/core.xml', xml.parse(`<cp:coreProperties xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties" xmlns:dc="http://purl.org/dc/elements/1.1/">${title}</cp:coreProperties>`), 'application/vnd.openxmlformats-package.core-properties+xml');
+    pkg.add('/docProps/app.xml', xml.parse('<Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/extended-properties"><Application>QVAC</Application></Properties>'), 'application/vnd.openxmlformats-officedocument.extended-properties+xml');
+    pkg.rels('/').add(REL_BASE + 'officeDocument', '/xl/workbook.xml');
+    pkg.rels('/').add(CORE_REL, '/docProps/core.xml');
+    pkg.rels('/').add(REL_BASE + 'extended-properties', '/docProps/app.xml');
+}