@bilig/workbook 0.42.0

package/dist/readback.js

@@ -0,0 +1,232 @@
+export const workbookReadbackIssueCodes = Object.freeze([
+    'readback_missing',
+    'duplicate_readback',
+    'value_mismatch',
+    'values_mismatch',
+    'formula_mismatch',
+    'formulas_mismatch',
+]);
+export function isWorkbookReadbackIssueCode(value) {
+    return typeof value === 'string' && workbookReadbackIssueCodes.some((code) => code === value);
+}
+function refKey(ref) {
+    return `${ref.kind}:${ref.id}`;
+}
+function readbackKey(readback) {
+    return refKey(readback.target);
+}
+function findReadback(readbacks, target) {
+    return readbacks.get(refKey(target));
+}
+function hasValue(readback) {
+    return Object.prototype.hasOwnProperty.call(readback, 'value');
+}
+function hasFormula(readback) {
+    return Object.prototype.hasOwnProperty.call(readback, 'formula');
+}
+function scalarValue(readback) {
+    if (hasValue(readback)) {
+        return readback.value;
+    }
+    if (readback.values?.length === 1 && readback.values[0]?.length === 1) {
+        return readback.values[0][0];
+    }
+    return undefined;
+}
+function scalarFormula(readback) {
+    if (hasFormula(readback)) {
+        return readback.formula;
+    }
+    if (readback.formulas?.length === 1 && readback.formulas[0]?.length === 1) {
+        return readback.formulas[0][0];
+    }
+    return undefined;
+}
+function valuesMatrix(readback) {
+    if (readback.values !== undefined) {
+        return readback.values;
+    }
+    return hasValue(readback) ? [[readback.value]] : undefined;
+}
+function formulasMatrix(readback) {
+    if (readback.formulas !== undefined) {
+        return readback.formulas;
+    }
+    return hasFormula(readback) ? [[readback.formula]] : undefined;
+}
+function sameMatrix(left, right) {
+    return (left.length === right.length &&
+        left.every((leftRow, rowIndex) => leftRow.length === right[rowIndex]?.length &&
+            leftRow.every((leftValue, colIndex) => Object.is(leftValue, right[rowIndex]?.[colIndex]))));
+}
+function issue(input) {
+    return input;
+}
+function missingReadback(check) {
+    return issue({
+        code: 'readback_missing',
+        check,
+        ...(check.target !== undefined ? { target: check.target } : {}),
+        message: `${check.target?.label ?? check.kind} has no readback`,
+    });
+}
+function duplicateReadback(check, readback) {
+    return issue({
+        code: 'duplicate_readback',
+        check,
+        target: readback.target,
+        message: `${readback.target.label} has more than one readback`,
+    });
+}
+function valueMismatch(check, expected, actual) {
+    return issue({
+        code: 'value_mismatch',
+        check,
+        ...(check.target !== undefined ? { target: check.target } : {}),
+        expected,
+        ...(actual !== undefined ? { actual } : {}),
+        message: actual === undefined
+            ? `${check.target?.label ?? check.kind} has no value readback`
+            : `${check.target?.label ?? check.kind} expected value ${JSON.stringify(expected)} but read ${JSON.stringify(actual)}`,
+    });
+}
+function valuesMismatch(check, expected, actual) {
+    return issue({
+        code: 'values_mismatch',
+        check,
+        ...(check.target !== undefined ? { target: check.target } : {}),
+        expected,
+        ...(actual !== undefined ? { actual } : {}),
+        message: actual === undefined
+            ? `${check.target?.label ?? check.kind} has no values readback`
+            : `${check.target?.label ?? check.kind} expected values ${JSON.stringify(expected)} but read ${JSON.stringify(actual)}`,
+    });
+}
+function formulaMismatch(check, expected, actual) {
+    return issue({
+        code: 'formula_mismatch',
+        check,
+        ...(check.target !== undefined ? { target: check.target } : {}),
+        expected,
+        ...(actual !== undefined ? { actual } : {}),
+        message: actual === undefined
+            ? `${check.target?.label ?? check.kind} has no formula readback`
+            : `${check.target?.label ?? check.kind} expected formula ${expected} but read ${actual ?? 'null'}`,
+    });
+}
+function formulasMismatch(check, expected, actual) {
+    return issue({
+        code: 'formulas_mismatch',
+        check,
+        ...(check.target !== undefined ? { target: check.target } : {}),
+        expected,
+        ...(actual !== undefined ? { actual } : {}),
+        message: actual === undefined
+            ? `${check.target?.label ?? check.kind} has no formulas readback`
+            : `${check.target?.label ?? check.kind} expected formulas ${JSON.stringify(expected)} but read ${JSON.stringify(actual)}`,
+    });
+}
+function checked(check, status) {
+    return {
+        ...check,
+        status,
+    };
+}
+function verifyCheck(check, readbacks) {
+    if (check.expectation === undefined) {
+        return { check };
+    }
+    if (check.target === undefined) {
+        return {
+            check: checked(check, 'failed'),
+            issue: missingReadback(check),
+        };
+    }
+    const readback = findReadback(readbacks, check.target);
+    if (readback === undefined) {
+        return {
+            check: checked(check, 'failed'),
+            issue: missingReadback(check),
+        };
+    }
+    if (check.expectation.kind === 'valueEquals') {
+        const actual = scalarValue(readback);
+        if (actual !== check.expectation.value) {
+            return {
+                check: checked(check, 'failed'),
+                issue: valueMismatch(check, check.expectation.value, actual),
+            };
+        }
+        return { check: checked(check, 'passed') };
+    }
+    if (check.expectation.kind === 'valuesEqual') {
+        const actual = valuesMatrix(readback);
+        if (actual === undefined || !sameMatrix(actual, check.expectation.values)) {
+            return {
+                check: checked(check, 'failed'),
+                issue: valuesMismatch(check, check.expectation.values, actual),
+            };
+        }
+        return { check: checked(check, 'passed') };
+    }
+    if (check.expectation.kind === 'formulaEquals') {
+        const actual = scalarFormula(readback);
+        if (actual !== check.expectation.formula) {
+            return {
+                check: checked(check, 'failed'),
+                issue: formulaMismatch(check, check.expectation.formula, actual),
+            };
+        }
+        return { check: checked(check, 'passed') };
+    }
+    const actual = formulasMatrix(readback);
+    if (actual === undefined || !sameMatrix(actual, check.expectation.formulas)) {
+        return {
+            check: checked(check, 'failed'),
+            issue: formulasMismatch(check, check.expectation.formulas, actual),
+        };
+    }
+    return { check: checked(check, 'passed') };
+}
+export function verifyWorkbookReadbacks(checks, readbacks) {
+    const readbackByTarget = new Map();
+    const duplicateReadbacks = new Map();
+    readbacks.forEach((readback) => {
+        const key = readbackKey(readback);
+        if (readbackByTarget.has(key)) {
+            duplicateReadbacks.set(key, readback);
+            return;
+        }
+        readbackByTarget.set(key, readback);
+    });
+    const verifiedChecks = [];
+    const issues = [];
+    checks.forEach((check, checkIndex) => {
+        if (check.target !== undefined) {
+            const duplicate = duplicateReadbacks.get(refKey(check.target));
+            if (duplicate !== undefined) {
+                const failedCheck = checked(check, 'failed');
+                verifiedChecks.push(failedCheck);
+                issues.push({
+                    ...duplicateReadback(failedCheck, duplicate),
+                    path: `checks[${String(checkIndex)}]`,
+                });
+                return;
+            }
+        }
+        const result = verifyCheck(check, readbackByTarget);
+        verifiedChecks.push(result.check);
+        if (result.issue !== undefined) {
+            issues.push({
+                ...result.issue,
+                path: `checks[${String(checkIndex)}]`,
+            });
+        }
+    });
+    return {
+        status: issues.length === 0 ? 'passed' : 'failed',
+        checks: verifiedChecks,
+        issues,
+    };
+}
+//# sourceMappingURL=readback.js.map

package/dist/readback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readback.js","sourceRoot":"","sources":["../src/readback.ts"],"names":[],"mappings":"AA4BA,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,CAAC;IACtD,kBAAkB;IAClB,oBAAoB;IACpB,gBAAgB;IAChB,iBAAiB;IACjB,kBAAkB;IAClB,mBAAmB;CAC2B,CAAC,CAAA;AAEjD,MAAM,UAAU,2BAA2B,CAAC,KAAc;IACxD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,0BAA0B,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,CAAA;AAC/F,CAAC;AAkBD,SAAS,MAAM,CAAC,GAAgB;IAC9B,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE,EAAE,CAAA;AAChC,CAAC;AAED,SAAS,WAAW,CAAC,QAA6B;IAChD,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;AAChC,CAAC;AAED,SAAS,YAAY,CAAC,SAAmD,EAAE,MAAmB;IAC5F,OAAO,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;AACtC,CAAC;AAED,SAAS,QAAQ,CAAC,QAA6B;IAC7C,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;AAChE,CAAC;AAED,SAAS,UAAU,CAAC,QAA6B;IAC/C,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;AAClE,CAAC;AAED,SAAS,WAAW,CAAC,QAA6B;IAChD,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvB,OAAO,QAAQ,CAAC,KAAK,CAAA;IACvB,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;QACtE,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAC9B,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,SAAS,aAAa,CAAC,QAA6B;IAClD,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzB,OAAO,QAAQ,CAAC,OAAO,CAAA;IACzB,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1E,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAChC,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,SAAS,YAAY,CAAC,QAA6B;IACjD,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,QAAQ,CAAC,MAAM,CAAA;IACxB,CAAC;IACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;AAC5D,CAAC;AAED,SAAS,cAAc,CAAC,QAA6B;IACnD,IAAI,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO,QAAQ,CAAC,QAAQ,CAAA;IAC1B,CAAC;IACD,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;AAChE,CAAC;AAED,SAAS,UAAU,CAAI,IAA+B,EAAE,KAAgC;IACtF,OAAO,CACL,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAC5B,IAAI,CAAC,KAAK,CACR,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CACpB,OAAO,CAAC,MAAM,KAAK,KAAK,CAAC,QAAQ,CAAC,EAAE,MAAM;YAC1C,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAC5F,CACF,CAAA;AACH,CAAC;AAED,SAAS,KAAK,CAAC,KAA4B;IACzC,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,eAAe,CAAC,KAA0B;IACjD,OAAO,KAAK,CAAC;QACX,IAAI,EAAE,kBAAkB;QACxB,KAAK;QACL,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,kBAAkB;KAChE,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,KAA0B,EAAE,QAA6B;IAClF,OAAO,KAAK,CAAC;QACX,IAAI,EAAE,oBAAoB;QAC1B,KAAK;QACL,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,6BAA6B;KAC/D,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,KAA0B,EAAE,QAAsB,EAAE,MAAqB;IAC9F,OAAO,KAAK,CAAC;QACX,IAAI,EAAE,gBAAgB;QACtB,KAAK;QACL,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,QAAQ;QACR,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3C,OAAO,EACL,MAAM,KAAK,SAAS;YAClB,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,wBAAwB;YAC9D,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,mBAAmB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;KAC3H,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,cAAc,CACrB,KAA0B,EAC1B,QAA8C,EAC9C,MAA6C;IAE7C,OAAO,KAAK,CAAC;QACX,IAAI,EAAE,iBAAiB;QACvB,KAAK;QACL,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,QAAQ;QACR,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3C,OAAO,EACL,MAAM,KAAK,SAAS;YAClB,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,yBAAyB;YAC/D,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,oBAAoB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;KAC5H,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,KAA0B,EAAE,QAAgB,EAAE,MAAiC;IACtG,OAAO,KAAK,CAAC;QACX,IAAI,EAAE,kBAAkB;QACxB,KAAK;QACL,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,QAAQ;QACR,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3C,OAAO,EACL,MAAM,KAAK,SAAS;YAClB,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,0BAA0B;YAChE,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,qBAAqB,QAAQ,aAAa,MAAM,IAAI,MAAM,EAAE;KACvG,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,KAA0B,EAC1B,QAAiD,EACjD,MAA2D;IAE3D,OAAO,KAAK,CAAC;QACX,IAAI,EAAE,mBAAmB;QACzB,KAAK;QACL,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,QAAQ;QACR,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3C,OAAO,EACL,MAAM,KAAK,SAAS;YAClB,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,2BAA2B;YACjE,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,sBAAsB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;KAC9H,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,KAA0B,EAAE,MAAqC;IAChF,OAAO;QACL,GAAG,KAAK;QACR,MAAM;KACP,CAAA;AACH,CAAC;AAED,SAAS,WAAW,CAClB,KAA0B,EAC1B,SAAmD;IAEnD,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO,EAAE,KAAK,EAAE,CAAA;IAClB,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO;YACL,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC;YAC/B,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;SAC9B,CAAA;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,YAAY,CAAC,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACtD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO;YACL,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC;YAC/B,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;SAC9B,CAAA;IACH,CAAC;IAED,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAA;QACpC,IAAI,MAAM,KAAK,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;YACvC,OAAO;gBACL,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC;gBAC/B,KAAK,EAAE,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC;aAC7D,CAAA;QACH,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAA;IAC5C,CAAC;IAED,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;QACrC,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1E,OAAO;gBACL,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC;gBAC/B,KAAK,EAAE,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC;aAC/D,CAAA;QACH,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAA;IAC5C,CAAC;IAED,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QAC/C,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;QACtC,IAAI,MAAM,KAAK,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YACzC,OAAO;gBACL,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC;gBAC/B,KAAK,EAAE,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC;aACjE,CAAA;QACH,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAA;IAC5C,CAAC;IAED,MAAM,MAAM,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;IACvC,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5E,OAAO;YACL,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC;YAC/B,KAAK,EAAE,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;SACnE,CAAA;IACH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAA;AAC5C,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,MAAsC,EACtC,SAAyC;IAEzC,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAA+B,CAAA;IAC/D,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAA+B,CAAA;IACjE,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,MAAM,GAAG,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAA;QACjC,IAAI,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,kBAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;YACrC,OAAM;QACR,CAAC;QACD,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;IACrC,CAAC,CAAC,CAAA;IAEF,MAAM,cAAc,GAA0B,EAAE,CAAA;IAChD,MAAM,MAAM,GAA4B,EAAE,CAAA;IAE1C,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;QACnC,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,SAAS,GAAG,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;YAC9D,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC5B,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;gBAC5C,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAChC,MAAM,CAAC,IAAI,CAAC;oBACV,GAAG,iBAAiB,CAAC,WAAW,EAAE,SAAS,CAAC;oBAC5C,IAAI,EAAE,UAAU,MAAM,CAAC,UAAU,CAAC,GAAG;iBACtC,CAAC,CAAA;gBACF,OAAM;YACR,CAAC;QACH,CAAC;QACD,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAA;QACnD,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACjC,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC;gBACV,GAAG,MAAM,CAAC,KAAK;gBACf,IAAI,EAAE,UAAU,MAAM,CAAC,UAAU,CAAC,GAAG;aACtC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ;QACjD,MAAM,EAAE,cAAc;QACtB,MAAM;KACP,CAAA;AACH,CAAC"}

package/dist/requirements.d.ts

@@ -0,0 +1,34 @@
+import { type WorkbookCheckExpectationDescription, type WorkbookRefDescription } from './describe.js';
+import type { WorkbookActionPlan } from './model.js';
+import type { EngineOp } from './ops.js';
+export type WorkbookRuntimeRequirementKind = 'apply' | 'read' | 'verify';
+export type WorkbookRuntimeCapability = 'writeFormula' | 'writeValue' | 'format' | 'clear' | 'applyOp' | 'read' | 'verifyCheck';
+export type WorkbookRuntimeMaterialization = 'concreteOp' | 'adapterMaterialization' | 'providedOp';
+export interface WorkbookRuntimeRequirement {
+    readonly kind: WorkbookRuntimeRequirementKind;
+    readonly capability: WorkbookRuntimeCapability;
+    readonly path: string;
+    readonly message: string;
+    readonly materialization?: WorkbookRuntimeMaterialization;
+    readonly commandIndex?: number;
+    readonly checkIndex?: number;
+    readonly opIndex?: number;
+    readonly opIndexes?: readonly number[];
+    readonly opKind?: string;
+    readonly checkKind?: string;
+    readonly target?: WorkbookRefDescription;
+    readonly refs?: readonly WorkbookRefDescription[];
+    readonly expectation?: WorkbookCheckExpectationDescription;
+}
+export interface WorkbookRuntimeRequirements {
+    readonly modelName: string;
+    readonly actionName: string;
+    readonly requirements: readonly WorkbookRuntimeRequirement[];
+}
+export interface WorkbookRuntimePreview {
+    readonly modelName: string;
+    readonly actionName: string;
+    readonly requirements: readonly WorkbookRuntimeRequirement[];
+    readonly materializedOps: readonly EngineOp[];
+}
+export declare function describeRuntimeRequirements<Refs>(plan: WorkbookActionPlan<Refs>): WorkbookRuntimeRequirements;

package/dist/requirements.js

@@ -0,0 +1,223 @@
+import { describeRef } from './describe.js';
+function describedRef(ref) {
+    return ref === undefined ? {} : { target: describeRef(ref) };
+}
+function describedRefs(refs) {
+    return refs === undefined || refs.length === 0 ? {} : { refs: refs.map(describeRef) };
+}
+function commandCapability(command) {
+    switch (command.kind) {
+        case 'writeFormula':
+            return 'writeFormula';
+        case 'writeValue':
+            return 'writeValue';
+        case 'format':
+            return 'format';
+        case 'clear':
+            return 'clear';
+        case 'op':
+            return 'applyOp';
+    }
+}
+function commandRefs(command) {
+    return command.kind === 'writeFormula' ? command.inputs : undefined;
+}
+function commandMessage(command) {
+    switch (command.kind) {
+        case 'writeFormula':
+            return `Apply formula write to ${command.target.label}`;
+        case 'writeValue':
+            return `Apply value write to ${command.target.label}`;
+        case 'format':
+            return `Apply format to ${command.target.label}`;
+        case 'clear':
+            return `Apply clear to ${command.target.label}`;
+        case 'op':
+            return command.target === undefined
+                ? `Apply workbook op ${command.op.kind}`
+                : `Apply workbook op ${command.op.kind} to ${command.target.label}`;
+    }
+}
+function expectationDescription(expectation) {
+    if (expectation.kind === 'valueEquals') {
+        return {
+            kind: 'valueEquals',
+            value: expectation.value,
+        };
+    }
+    if (expectation.kind === 'valuesEqual') {
+        return {
+            kind: 'valuesEqual',
+            values: expectation.values.map((row) => [...row]),
+        };
+    }
+    if (expectation.kind === 'formulaEquals') {
+        return {
+            kind: 'formulaEquals',
+            formula: expectation.formula,
+            inputs: expectation.inputs.map(describeRef),
+        };
+    }
+    return {
+        kind: 'formulasEqual',
+        formulas: expectation.formulas.map((row) => [...row]),
+    };
+}
+function concreteSingleCell(target) {
+    if (target.kind !== 'range') {
+        return null;
+    }
+    const range = target.range;
+    return range.startAddress === range.endAddress ? { sheetName: range.sheetName, address: range.startAddress } : null;
+}
+function expectedConcreteOp(command) {
+    if (command.kind === 'op') {
+        return command.op;
+    }
+    const target = concreteSingleCell(command.target);
+    if (target === null) {
+        return null;
+    }
+    switch (command.kind) {
+        case 'writeFormula':
+            return {
+                kind: 'setCellFormula',
+                sheetName: target.sheetName,
+                address: target.address,
+                formula: command.formula,
+            };
+        case 'writeValue':
+            return {
+                kind: 'setCellValue',
+                sheetName: target.sheetName,
+                address: target.address,
+                value: command.value,
+            };
+        case 'clear':
+            return {
+                kind: 'clearCell',
+                sheetName: target.sheetName,
+                address: target.address,
+            };
+        case 'format':
+            if (command.numberFormat === undefined) {
+                return null;
+            }
+            return {
+                kind: 'setCellFormat',
+                sheetName: target.sheetName,
+                address: target.address,
+                format: command.numberFormat,
+            };
+    }
+}
+function opIndexesFor(command, ops) {
+    const expected = expectedConcreteOp(command);
+    if (expected === null) {
+        return [];
+    }
+    const expectedKey = opKey(expected);
+    return ops.flatMap((op, index) => (opKey(op) === expectedKey ? [index] : []));
+}
+function commandMaterialization(command, opIndexes) {
+    if (command.kind === 'op') {
+        return 'providedOp';
+    }
+    return opIndexes.length === 0 ? 'adapterMaterialization' : 'concreteOp';
+}
+function commandRequirement(command, commandIndex, ops) {
+    const opIndexes = opIndexesFor(command, ops);
+    return {
+        kind: 'apply',
+        capability: commandCapability(command),
+        path: `commands[${String(commandIndex)}]`,
+        commandIndex,
+        materialization: commandMaterialization(command, opIndexes),
+        ...(opIndexes.length > 0 ? { opIndexes } : {}),
+        ...(command.kind === 'op' ? { opKind: command.op.kind } : {}),
+        ...describedRef(command.target),
+        ...describedRefs(commandRefs(command)),
+        message: commandMessage(command),
+    };
+}
+function readRequirement(check, checkIndex) {
+    if (check.expectation === undefined) {
+        return null;
+    }
+    return {
+        kind: 'read',
+        capability: 'read',
+        path: `checks[${String(checkIndex)}]`,
+        checkIndex,
+        checkKind: check.kind,
+        ...describedRef(check.target),
+        ...describedRefs(check.expectation.kind === 'formulaEquals' ? check.expectation.inputs : undefined),
+        expectation: expectationDescription(check.expectation),
+        message: `Read ${check.target?.label ?? check.kind} for ${check.expectation.kind}`,
+    };
+}
+function verifyRequirement(check, checkIndex) {
+    if (check.expectation !== undefined) {
+        return null;
+    }
+    return {
+        kind: 'verify',
+        capability: 'verifyCheck',
+        path: `checks[${String(checkIndex)}]`,
+        checkIndex,
+        checkKind: check.kind,
+        ...describedRef(check.target),
+        ...describedRefs(check.refs),
+        message: `Verify ${check.kind} for ${check.target?.label ?? check.kind}`,
+    };
+}
+function canonicalValue(value) {
+    if (Array.isArray(value)) {
+        return value.map(canonicalValue);
+    }
+    if (typeof value === 'object' && value !== null) {
+        return Object.fromEntries(Object.entries(value)
+            .toSorted(([left], [right]) => left.localeCompare(right))
+            .map(([key, entry]) => [key, canonicalValue(entry)]));
+    }
+    return value;
+}
+function opKey(op) {
+    return JSON.stringify(canonicalValue(op));
+}
+export function describeRuntimeRequirements(plan) {
+    const requirements = plan.commands.map((command, commandIndex) => commandRequirement(command, commandIndex, plan.ops));
+    const commandBackedOpIndexes = new Set(plan.commands.flatMap((command) => opIndexesFor(command, plan.ops)));
+    plan.ops.forEach((op, opIndex) => {
+        if (commandBackedOpIndexes.has(opIndex)) {
+            return;
+        }
+        requirements.push({
+            kind: 'apply',
+            capability: 'applyOp',
+            path: `ops[${String(opIndex)}]`,
+            opIndex,
+            materialization: 'providedOp',
+            opKind: op.kind,
+            message: `Apply workbook op ${op.kind}`,
+        });
+    });
+    plan.checks.forEach((check, checkIndex) => {
+        const read = readRequirement(check, checkIndex);
+        if (read !== null) {
+            requirements.push(read);
+        }
+    });
+    plan.checks.forEach((check, checkIndex) => {
+        const verify = verifyRequirement(check, checkIndex);
+        if (verify !== null) {
+            requirements.push(verify);
+        }
+    });
+    return {
+        modelName: plan.modelName,
+        actionName: plan.actionName,
+        requirements,
+    };
+}
+//# sourceMappingURL=requirements.js.map

package/dist/requirements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requirements.js","sourceRoot":"","sources":["../src/requirements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAyE,MAAM,eAAe,CAAA;AA0ClH,SAAS,YAAY,CAAC,GAA4B;IAChD,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,CAAA;AAC9D,CAAC;AAED,SAAS,aAAa,CAAC,IAAwC;IAC7D,OAAO,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAA;AACvF,CAAC;AAED,SAAS,iBAAiB,CAAC,OAA8B;IACvD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,cAAc;YACjB,OAAO,cAAc,CAAA;QACvB,KAAK,YAAY;YACf,OAAO,YAAY,CAAA;QACrB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB,KAAK,OAAO;YACV,OAAO,OAAO,CAAA;QAChB,KAAK,IAAI;YACP,OAAO,SAAS,CAAA;IACpB,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,OAA8B;IACjD,OAAO,OAAO,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;AACrE,CAAC;AAED,SAAS,cAAc,CAAC,OAA8B;IACpD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,cAAc;YACjB,OAAO,0BAA0B,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QACzD,KAAK,YAAY;YACf,OAAO,wBAAwB,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QACvD,KAAK,QAAQ;YACX,OAAO,mBAAmB,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QAClD,KAAK,OAAO;YACV,OAAO,kBAAkB,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QACjD,KAAK,IAAI;YACP,OAAO,OAAO,CAAC,MAAM,KAAK,SAAS;gBACjC,CAAC,CAAC,qBAAqB,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE;gBACxC,CAAC,CAAC,qBAAqB,OAAO,CAAC,EAAE,CAAC,IAAI,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IACzE,CAAC;AACH,CAAC;AAED,SAAS,sBAAsB,CAAC,WAAqC;IACnE,IAAI,WAAW,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QACvC,OAAO;YACL,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,WAAW,CAAC,KAAK;SACzB,CAAA;IACH,CAAC;IACD,IAAI,WAAW,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QACvC,OAAO;YACL,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;SAClD,CAAA;IACH,CAAC;IACD,IAAI,WAAW,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QACzC,OAAO;YACL,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC;SAC5C,CAAA;IACH,CAAC;IACD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;KACtD,CAAA;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAmB;IAC7C,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;IAC1B,OAAO,KAAK,CAAC,YAAY,KAAK,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACrH,CAAC;AAED,SAAS,kBAAkB,CAAC,OAA8B;IACxD,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,OAAO,CAAC,EAAE,CAAA;IACnB,CAAC;IACD,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACjD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,cAAc;YACjB,OAAO;gBACL,IAAI,EAAE,gBAAgB;gBACtB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,OAAO,EAAE,OAAO,CAAC,OAAO;aACzB,CAAA;QACH,KAAK,YAAY;YACf,OAAO;gBACL,IAAI,EAAE,cAAc;gBACpB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,KAAK,EAAE,OAAO,CAAC,KAAK;aACrB,CAAA;QACH,KAAK,OAAO;YACV,OAAO;gBACL,IAAI,EAAE,WAAW;gBACjB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;aACxB,CAAA;QACH,KAAK,QAAQ;YACX,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBACvC,OAAO,IAAI,CAAA;YACb,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,eAAe;gBACrB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,MAAM,EAAE,OAAO,CAAC,YAAY;aAC7B,CAAA;IACL,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,OAA8B,EAAE,GAA0B;IAC9E,MAAM,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAC5C,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAA;IACnC,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAC/E,CAAC;AAED,SAAS,sBAAsB,CAAC,OAA8B,EAAE,SAA4B;IAC1F,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,YAAY,CAAA;IACrB,CAAC;IACD,OAAO,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,YAAY,CAAA;AACzE,CAAC;AAED,SAAS,kBAAkB,CAAC,OAA8B,EAAE,YAAoB,EAAE,GAA0B;IAC1G,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;IAC5C,OAAO;QACL,IAAI,EAAE,OAAO;QACb,UAAU,EAAE,iBAAiB,CAAC,OAAO,CAAC;QACtC,IAAI,EAAE,YAAY,MAAM,CAAC,YAAY,CAAC,GAAG;QACzC,YAAY;QACZ,eAAe,EAAE,sBAAsB,CAAC,OAAO,EAAE,SAAS,CAAC;QAC3D,GAAG,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC;QAC/B,GAAG,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACtC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;KACjC,CAAA;AACH,CAAC;AAED,SAAS,eAAe,CAAC,KAA0B,EAAE,UAAkB;IACrE,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,UAAU,MAAM,CAAC,UAAU,CAAC,GAAG;QACrC,UAAU;QACV,SAAS,EAAE,KAAK,CAAC,IAAI;QACrB,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;QAC7B,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACnG,WAAW,EAAE,sBAAsB,CAAC,KAAK,CAAC,WAAW,CAAC;QACtD,OAAO,EAAE,QAAQ,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE;KACnF,CAAA;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,KAA0B,EAAE,UAAkB;IACvE,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,aAAa;QACzB,IAAI,EAAE,UAAU,MAAM,CAAC,UAAU,CAAC,GAAG;QACrC,UAAU;QACV,SAAS,EAAE,KAAK,CAAC,IAAI;QACrB,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;QAC7B,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC;QAC5B,OAAO,EAAE,UAAU,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE;KACzE,CAAA;AACH,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;IAClC,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;aAClB,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;aACxD,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CACvD,CAAA;IACH,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,KAAK,CAAC,EAAc;IAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAA;AAC3C,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAO,IAA8B;IAC9E,MAAM,YAAY,GAAiC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,CAC7F,kBAAkB,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,CACpD,CAAA;IACD,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IAE3G,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE;QAC/B,IAAI,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACxC,OAAM;QACR,CAAC;QACD,YAAY,CAAC,IAAI,CAAC;YAChB,IAAI,EAAE,OAAO;YACb,UAAU,EAAE,SAAS;YACrB,IAAI,EAAE,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG;YAC/B,OAAO;YACP,eAAe,EAAE,YAAY;YAC7B,MAAM,EAAE,EAAE,CAAC,IAAI;YACf,OAAO,EAAE,qBAAqB,EAAE,CAAC,IAAI,EAAE;SACxC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;QACxC,MAAM,IAAI,GAAG,eAAe,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;QAC/C,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACzB,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;QACxC,MAAM,MAAM,GAAG,iBAAiB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;QACnD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC3B,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,YAAY;KACb,CAAA;AACH,CAAC"}

package/dist/result.d.ts

@@ -0,0 +1,63 @@
+import type { LiteralInput } from '@bilig/protocol';
+import type { WorkbookRef } from './find.js';
+import type { WorkbookActionInput } from './input.js';
+import type { EngineOp } from './ops.js';
+export type WorkbookCheckStatus = 'planned' | 'passed' | 'failed';
+export type WorkbookCheckExpectation = {
+    readonly kind: 'valueEquals';
+    readonly value: LiteralInput;
+} | {
+    readonly kind: 'valuesEqual';
+    readonly values: readonly (readonly LiteralInput[])[];
+} | {
+    readonly kind: 'formulaEquals';
+    readonly formula: string;
+    readonly inputs: readonly WorkbookRef[];
+} | {
+    readonly kind: 'formulasEqual';
+    readonly formulas: readonly (readonly (string | null)[])[];
+};
+export interface WorkbookCheckResult {
+    readonly status: WorkbookCheckStatus;
+    readonly kind: string;
+    readonly target?: WorkbookRef;
+    readonly refs?: readonly WorkbookRef[];
+    readonly message: string;
+    readonly expectation?: WorkbookCheckExpectation;
+}
+export interface WorkbookChangeSummary {
+    readonly kind: string;
+    readonly target?: WorkbookRef;
+    readonly message: string;
+}
+export interface WorkbookUndoRef {
+    readonly id: string;
+    readonly ops?: readonly EngineOp[];
+}
+export interface WorkbookAppliedSummary {
+    readonly opCount: number;
+    readonly ops?: readonly EngineOp[];
+}
+export type WorkbookRunErrorCode = 'action_not_found' | 'invalid_action_input' | 'find_failed' | 'checks_failed' | 'action_failed' | 'duplicate_ref' | 'command_target_not_resolved' | 'formula_input_not_resolved' | 'invalid_formula' | 'change_target_not_resolved' | 'check_status_not_planned' | 'check_target_not_resolved' | 'check_ref_not_resolved' | 'check_expectation_input_not_resolved' | 'invalid_check_expectation_formula' | 'invalid_workbook_op' | 'op_target_mismatch' | 'missing_concrete_op' | 'missing_workbook_op' | 'apply_failed' | 'readback_failed' | 'readback_missing' | 'duplicate_readback' | 'value_mismatch' | 'values_mismatch' | 'formula_mismatch' | 'formulas_mismatch' | 'invalid_check_verification' | 'check_verification_failed' | 'check_failed' | 'check_not_verified' | 'invalid_runtime_result' | 'runtime_rejected';
+export declare const workbookRunErrorCodes: readonly ("action_not_found" | "invalid_action_input" | "find_failed" | "checks_failed" | "action_failed" | "duplicate_ref" | "command_target_not_resolved" | "formula_input_not_resolved" | "invalid_formula" | "change_target_not_resolved" | "check_status_not_planned" | "check_target_not_resolved" | "check_ref_not_resolved" | "check_expectation_input_not_resolved" | "invalid_check_expectation_formula" | "invalid_workbook_op" | "op_target_mismatch" | "missing_concrete_op" | "missing_workbook_op" | "apply_failed" | "readback_failed" | "readback_missing" | "duplicate_readback" | "value_mismatch" | "values_mismatch" | "formula_mismatch" | "formulas_mismatch" | "invalid_check_verification" | "check_verification_failed" | "check_failed" | "check_not_verified" | "invalid_runtime_result" | "runtime_rejected")[];
+export declare function isWorkbookRunErrorCode(value: unknown): value is WorkbookRunErrorCode;
+export interface WorkbookRunError {
+    readonly code: WorkbookRunErrorCode;
+    readonly message: string;
+    readonly path?: string;
+    readonly target?: WorkbookRef;
+    readonly check?: WorkbookCheckResult;
+    readonly expected?: WorkbookActionInput;
+    readonly actual?: WorkbookActionInput;
+}
+export type WorkbookRunResult = {
+    readonly status: 'done';
+    readonly changed: readonly WorkbookChangeSummary[];
+    readonly checks: readonly WorkbookCheckResult[];
+    readonly undo?: WorkbookUndoRef;
+    readonly applied?: WorkbookAppliedSummary;
+} | {
+    readonly status: 'failed';
+    readonly errors: readonly WorkbookRunError[];
+    readonly checks: readonly WorkbookCheckResult[];
+};

package/dist/result.js

@@ -0,0 +1,39 @@
+export const workbookRunErrorCodes = Object.freeze([
+    'action_not_found',
+    'invalid_action_input',
+    'find_failed',
+    'checks_failed',
+    'action_failed',
+    'duplicate_ref',
+    'command_target_not_resolved',
+    'formula_input_not_resolved',
+    'invalid_formula',
+    'change_target_not_resolved',
+    'check_status_not_planned',
+    'check_target_not_resolved',
+    'check_ref_not_resolved',
+    'check_expectation_input_not_resolved',
+    'invalid_check_expectation_formula',
+    'invalid_workbook_op',
+    'op_target_mismatch',
+    'missing_concrete_op',
+    'missing_workbook_op',
+    'apply_failed',
+    'readback_failed',
+    'readback_missing',
+    'duplicate_readback',
+    'value_mismatch',
+    'values_mismatch',
+    'formula_mismatch',
+    'formulas_mismatch',
+    'invalid_check_verification',
+    'check_verification_failed',
+    'check_failed',
+    'check_not_verified',
+    'invalid_runtime_result',
+    'runtime_rejected',
+]);
+export function isWorkbookRunErrorCode(value) {
+    return typeof value === 'string' && workbookRunErrorCodes.some((code) => code === value);
+}
+//# sourceMappingURL=result.js.map

package/dist/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAsFA,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjD,kBAAkB;IAClB,sBAAsB;IACtB,aAAa;IACb,eAAe;IACf,eAAe;IACf,eAAe;IACf,6BAA6B;IAC7B,4BAA4B;IAC5B,iBAAiB;IACjB,4BAA4B;IAC5B,0BAA0B;IAC1B,2BAA2B;IAC3B,wBAAwB;IACxB,sCAAsC;IACtC,mCAAmC;IACnC,qBAAqB;IACrB,oBAAoB;IACpB,qBAAqB;IACrB,qBAAqB;IACrB,cAAc;IACd,iBAAiB;IACjB,kBAAkB;IAClB,oBAAoB;IACpB,gBAAgB;IAChB,iBAAiB;IACjB,kBAAkB;IAClB,mBAAmB;IACnB,4BAA4B;IAC5B,2BAA2B;IAC3B,cAAc;IACd,oBAAoB;IACpB,wBAAwB;IACxB,kBAAkB;CACuB,CAAC,CAAA;AAE5C,MAAM,UAAU,sBAAsB,CAAC,KAAc;IACnD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,CAAA;AAC1F,CAAC"}

package/dist/run.d.ts

@@ -0,0 +1,21 @@
+import { type WorkbookRef } from './find.js';
+import type { WorkbookActionInput } from './input.js';
+import { type WorkbookActionMap, type WorkbookActionPlan, type WorkbookModel } from './model.js';
+import { type WorkbookRunReadback } from './readback.js';
+import type { WorkbookRuntimePreview } from './requirements.js';
+import { type WorkbookCheckResult, type WorkbookRunError, type WorkbookRunResult, type WorkbookUndoRef } from './result.js';
+type MaybePromise<T> = T | Promise<T>;
+export interface WorkbookRunApplyResult {
+    readonly status: 'applied' | 'failed';
+    readonly errors?: readonly WorkbookRunError[];
+    readonly undo?: WorkbookUndoRef;
+}
+export interface WorkbookRunAdapter<Refs = unknown> {
+    readonly preview?: (plan: WorkbookActionPlan<Refs>) => MaybePromise<WorkbookRuntimePreview>;
+    readonly apply: (plan: WorkbookActionPlan<Refs>) => MaybePromise<WorkbookRunApplyResult>;
+    readonly read?: (targets: readonly WorkbookRef[], plan: WorkbookActionPlan<Refs>) => MaybePromise<readonly WorkbookRunReadback[]>;
+    readonly verifyChecks?: (checks: readonly WorkbookCheckResult[], plan: WorkbookActionPlan<Refs>) => MaybePromise<readonly WorkbookCheckResult[]>;
+}
+export declare function runWorkbookPlan<Refs>(plan: WorkbookActionPlan<Refs>, adapter: WorkbookRunAdapter<Refs>): Promise<WorkbookRunResult>;
+export declare function runWorkbookAction<Refs, Actions extends WorkbookActionMap<Refs>>(model: WorkbookModel<Refs, Actions>, actionName: string, adapter: WorkbookRunAdapter<Refs>, input?: WorkbookActionInput): Promise<WorkbookRunResult>;
+export {};