@bilig/workbook 0.94.0 → 0.103.0

package/dist/testing.js

@@ -0,0 +1,85 @@
+import { describeRunResult } from './describe.js';
+import { checkRuntimeAdapter } from './requirements.js';
+import { runWorkbookPlan } from './run.js';
+import { checkWorkbookRunResultDescription } from './run-description.js';
+function adapterCheckIssue(code, path, message) {
+    return Object.freeze({
+        code,
+        path,
+        message,
+    });
+}
+function failedAdapterCheck(args) {
+    return Object.freeze({
+        status: 'failed',
+        ...(args.result !== undefined ? { result: args.result } : {}),
+        ...(args.description !== undefined ? { description: args.description } : {}),
+        errors: Object.freeze([...(args.errors ?? [])]),
+        issues: Object.freeze([...args.issues]),
+    });
+}
+function runErrorIssue(error) {
+    return adapterCheckIssue(error.code, error.path ?? 'result', error.message);
+}
+function runtimeAdapterIssue(issue) {
+    if (issue.code === 'invalid_requirements') {
+        return adapterCheckIssue('invalid_plan_data', issue.path ?? 'plan', issue.message);
+    }
+    return adapterCheckIssue('adapter_missing_capability', issue.method === undefined ? 'adapter' : `adapter.${issue.method}`, issue.message);
+}
+function strictOptions(options) {
+    return Object.freeze({
+        ...options,
+        strict: true,
+    });
+}
+export async function checkWorkbookRunAdapter(plan, adapter, options = {}) {
+    const adapterCheck = checkRuntimeAdapter(plan, adapter);
+    if (adapterCheck.status === 'invalid') {
+        return failedAdapterCheck({
+            issues: adapterCheck.issues.map(runtimeAdapterIssue),
+        });
+    }
+    const result = await runWorkbookPlan(plan, adapter, strictOptions(options));
+    const description = describeRunResult(result);
+    const descriptionCheck = checkWorkbookRunResultDescription(description);
+    if (descriptionCheck.status === 'invalid') {
+        return failedAdapterCheck({
+            result,
+            description,
+            issues: descriptionCheck.issues.map((issue) => adapterCheckIssue('invalid_run_result_description', issue.path, issue.message)),
+        });
+    }
+    if (result.status === 'failed') {
+        return failedAdapterCheck({
+            result,
+            description,
+            errors: result.errors,
+            issues: result.errors.map(runErrorIssue),
+        });
+    }
+    if (description.status !== 'done') {
+        return failedAdapterCheck({
+            result,
+            description,
+            issues: [
+                adapterCheckIssue('invalid_run_result_description', 'status', 'Workbook run adapter returned a done result with a non-done description'),
+            ],
+        });
+    }
+    return Object.freeze({
+        status: 'passed',
+        result,
+        description,
+        issues: Object.freeze([]),
+    });
+}
+export async function assertWorkbookRunAdapter(plan, adapter, options = {}) {
+    const check = await checkWorkbookRunAdapter(plan, adapter, options);
+    if (check.status === 'passed') {
+        return check.description;
+    }
+    const [firstIssue] = check.issues;
+    throw new Error(firstIssue?.message ?? 'Workbook run adapter check failed');
+}
+//# sourceMappingURL=testing.js.map

package/dist/testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing.js","sourceRoot":"","sources":["../src/testing.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAIjD,OAAO,EAAE,mBAAmB,EAAoC,MAAM,mBAAmB,CAAA;AACzF,OAAO,EAAE,eAAe,EAAoD,MAAM,UAAU,CAAA;AAC5F,OAAO,EAAE,iCAAiC,EAAE,MAAM,sBAAsB,CAAA;AA6BxE,SAAS,iBAAiB,CAAC,IAAsC,EAAE,IAAY,EAAE,OAAe;IAC9F,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,IAAI;QACJ,IAAI;QACJ,OAAO;KACR,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,IAK3B;IACC,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,MAAM,EAAE,QAAQ;QAChB,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5E,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;KACxC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,KAAuB;IAC5C,OAAO,iBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;AAC7E,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAkC;IAC7D,IAAI,KAAK,CAAC,IAAI,KAAK,sBAAsB,EAAE,CAAC;QAC1C,OAAO,iBAAiB,CAAC,mBAAmB,EAAE,KAAK,CAAC,IAAI,IAAI,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;IACpF,CAAC;IACD,OAAO,iBAAiB,CAAC,4BAA4B,EAAE,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;AAC3I,CAAC;AAED,SAAS,aAAa,CAAC,OAAuC;IAC5D,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,GAAG,OAAO;QACV,MAAM,EAAE,IAAI;KACb,CAAC,CAAA;AACJ,CAAC;AAYD,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,IAA4B,EAC5B,OAA2B,EAC3B,UAA0C,EAAE;IAE5C,MAAM,YAAY,GAAG,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IACvD,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACtC,OAAO,kBAAkB,CAAC;YACxB,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC;SACrD,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,CAAA;IAC3E,MAAM,WAAW,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAA;IAC7C,MAAM,gBAAgB,GAAG,iCAAiC,CAAC,WAAW,CAAC,CAAA;IACvE,IAAI,gBAAgB,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,kBAAkB,CAAC;YACxB,MAAM;YACN,WAAW;YACX,MAAM,EAAE,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iBAAiB,CAAC,gCAAgC,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;SAC/H,CAAC,CAAA;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,kBAAkB,CAAC;YACxB,MAAM;YACN,WAAW;YACX,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;SACzC,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,WAAW,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAClC,OAAO,kBAAkB,CAAC;YACxB,MAAM;YACN,WAAW;YACX,MAAM,EAAE;gBACN,iBAAiB,CACf,gCAAgC,EAChC,QAAQ,EACR,yEAAyE,CAC1E;aACF;SACF,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,MAAM,EAAE,QAAQ;QAChB,MAAM;QACN,WAAW;QACX,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EAAW,CAAC;KACnC,CAAC,CAAA;AACJ,CAAC;AAYD,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,IAA4B,EAC5B,OAA2B,EAC3B,UAA0C,EAAE;IAE5C,MAAM,KAAK,GAAG,MAAM,uBAAuB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IACnE,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC,WAAW,CAAA;IAC1B,CAAC;IACD,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,MAAM,CAAA;IACjC,MAAM,IAAI,KAAK,CAAC,UAAU,EAAE,OAAO,IAAI,mCAAmC,CAAC,CAAA;AAC7E,CAAC"}

package/fixtures/command-bundle.json

@@ -0,0 +1,28 @@
+{
+  "id": "agent-bundle-1",
+  "targetRevision": 12,
+  "idempotencyKey": "agent-bundle-1-on-12",
+  "scope": {
+    "maxTouchedCells": 1
+  },
+  "commands": [
+    {
+      "id": "write-result",
+      "kind": "op",
+      "destructive": true,
+      "touchedRanges": [
+        {
+          "sheetName": "Resolved",
+          "startAddress": "C1",
+          "endAddress": "C1"
+        }
+      ],
+      "op": {
+        "kind": "setCellFormula",
+        "sheetName": "Resolved",
+        "address": "C1",
+        "formula": "input*factor"
+      }
+    }
+  ]
+}

package/fixtures/command-result.json

@@ -0,0 +1,58 @@
+{
+  "status": "applied",
+  "bundleId": "agent-bundle-1",
+  "targetRevision": 12,
+  "idempotencyKey": "agent-bundle-1-on-12",
+  "commandCount": 1,
+  "touchedRanges": [
+    {
+      "sheetName": "Resolved",
+      "startAddress": "C1",
+      "endAddress": "C1"
+    }
+  ],
+  "touchedCellCount": 1,
+  "receipts": [
+    {
+      "status": "applied",
+      "featureId": "workbook-op",
+      "commandId": "write-result",
+      "category": "operation",
+      "previewOps": [
+        {
+          "kind": "setCellFormula",
+          "sheetName": "Resolved",
+          "address": "C1",
+          "formula": "input*factor"
+        }
+      ],
+      "appliedOps": [
+        {
+          "kind": "setCellFormula",
+          "sheetName": "Resolved",
+          "address": "C1",
+          "formula": "input*factor"
+        }
+      ],
+      "changedRanges": [
+        {
+          "sheetName": "Resolved",
+          "startAddress": "C1",
+          "endAddress": "C1"
+        }
+      ],
+      "proof": {
+        "source": "fixture"
+      }
+    }
+  ],
+  "matched": true,
+  "changedRanges": [
+    {
+      "sheetName": "Resolved",
+      "startAddress": "C1",
+      "endAddress": "C1"
+    }
+  ],
+  "revision": 13
+}

package/fixtures/invalid-plan.json

@@ -0,0 +1,9 @@
+{
+  "modelName": "named-range-formula",
+  "actionName": "calculate",
+  "refsUsed": "not-an-array",
+  "commands": [],
+  "ops": [],
+  "changed": [],
+  "checks": []
+}

package/fixtures/readback-proof.json

@@ -0,0 +1,64 @@
+{
+  "checks": [
+    {
+      "status": "planned",
+      "kind": "formulaEquals",
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "message": "result formula equals input*factor",
+      "expectation": {
+        "kind": "formulaEquals",
+        "formula": "input*factor",
+        "inputs": [
+          {
+            "kind": "name",
+            "id": "name_input",
+            "label": "input",
+            "name": "input"
+          },
+          {
+            "kind": "name",
+            "id": "name_factor",
+            "label": "factor",
+            "name": "factor"
+          }
+        ],
+        "labels": [
+          {
+            "name": "input",
+            "ref": {
+              "kind": "name",
+              "id": "name_input",
+              "label": "input",
+              "name": "input"
+            }
+          },
+          {
+            "name": "factor",
+            "ref": {
+              "kind": "name",
+              "id": "name_factor",
+              "label": "factor",
+              "name": "factor"
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "readbacks": [
+    {
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "formula": "input*factor"
+    }
+  ]
+}

package/fixtures/runtime-requirements.json

@@ -0,0 +1,72 @@
+{
+  "modelName": "named-range-formula",
+  "actionName": "calculate",
+  "requirements": [
+    {
+      "kind": "apply",
+      "capability": "writeFormula",
+      "commandIndex": 0,
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "refs": [
+        {
+          "kind": "name",
+          "id": "name_input",
+          "label": "input",
+          "name": "input"
+        },
+        {
+          "kind": "name",
+          "id": "name_factor",
+          "label": "factor",
+          "name": "factor"
+        }
+      ],
+      "message": "Apply formula write to result"
+    },
+    {
+      "kind": "read",
+      "capability": "read",
+      "checkIndex": 1,
+      "checkKind": "formulaEquals",
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "refs": [
+        {
+          "kind": "name",
+          "id": "name_input",
+          "label": "input",
+          "name": "input"
+        },
+        {
+          "kind": "name",
+          "id": "name_factor",
+          "label": "factor",
+          "name": "factor"
+        }
+      ],
+      "message": "Read result for formulaEquals"
+    },
+    {
+      "kind": "verify",
+      "capability": "verifyCheck",
+      "checkIndex": 0,
+      "checkKind": "exists",
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "message": "Verify exists for result"
+    }
+  ]
+}

package/fixtures/strict-run-failure.json

@@ -0,0 +1,11 @@
+{
+  "status": "failed",
+  "errors": [
+    {
+      "code": "apply_not_verified",
+      "message": "Adapter did not return both previewOps and appliedOps"
+    }
+  ],
+  "changed": [],
+  "checks": []
+}

package/fixtures/strict-run-success.json

@@ -0,0 +1,118 @@
+{
+  "status": "done",
+  "apply": {
+    "matched": true,
+    "planId": "bilig-plan-v1:1d10ebcfda99753e809362618290ef8d",
+    "baseRevision": 0,
+    "revision": 1,
+    "previewOps": [
+      {
+        "kind": "setCellFormula",
+        "sheetName": "Resolved",
+        "address": "C1",
+        "formula": "input*factor"
+      }
+    ],
+    "appliedOps": [
+      {
+        "kind": "setCellFormula",
+        "sheetName": "Resolved",
+        "address": "C1",
+        "formula": "input*factor"
+      }
+    ],
+    "commandReceipts": [
+      {
+        "commandIndex": 0,
+        "commandKind": "writeFormula",
+        "commandDigest": "bilig-command-v1:65870d1526258bc9da2e9e6489ddc3ba",
+        "previewOps": [
+          {
+            "kind": "setCellFormula",
+            "sheetName": "Resolved",
+            "address": "C1",
+            "formula": "input*factor"
+          }
+        ],
+        "appliedOps": [
+          {
+            "kind": "setCellFormula",
+            "sheetName": "Resolved",
+            "address": "C1",
+            "formula": "input*factor"
+          }
+        ],
+        "resolvedRefs": {
+          "target": {
+            "kind": "name",
+            "id": "name_result",
+            "label": "result",
+            "name": "result"
+          },
+          "inputs": [
+            {
+              "kind": "name",
+              "id": "name_input",
+              "label": "input",
+              "name": "input"
+            },
+            {
+              "kind": "name",
+              "id": "name_factor",
+              "label": "factor",
+              "name": "factor"
+            }
+          ]
+        }
+      }
+    ],
+    "proof": {
+      "source": "fixture"
+    }
+  },
+  "changed": [
+    {
+      "kind": "writeFormula",
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "message": "Write formula to result"
+    }
+  ],
+  "checks": [
+    {
+      "status": "passed",
+      "kind": "exists",
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "message": "result exists",
+      "proof": {
+        "source": "fixture"
+      }
+    },
+    {
+      "status": "passed",
+      "kind": "formulaEquals",
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "message": "result formula equals input*factor",
+      "proof": {
+        "source": "readback",
+        "formula": "input*factor",
+        "expectedFormula": "input*factor",
+        "materializedFormula": "input*factor"
+      }
+    }
+  ]
+}

package/fixtures/valid-plan.json

@@ -0,0 +1,145 @@
+{
+  "modelName": "named-range-formula",
+  "actionName": "calculate",
+  "refsUsed": [
+    {
+      "kind": "name",
+      "id": "name_input",
+      "label": "input",
+      "name": "input"
+    },
+    {
+      "kind": "name",
+      "id": "name_factor",
+      "label": "factor",
+      "name": "factor"
+    },
+    {
+      "kind": "name",
+      "id": "name_result",
+      "label": "result",
+      "name": "result"
+    }
+  ],
+  "commands": [
+    {
+      "kind": "writeFormula",
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "formula": "(input)*(factor)",
+      "inputs": [
+        {
+          "kind": "name",
+          "id": "name_input",
+          "label": "input",
+          "name": "input"
+        },
+        {
+          "kind": "name",
+          "id": "name_factor",
+          "label": "factor",
+          "name": "factor"
+        }
+      ],
+      "labels": [
+        {
+          "name": "input",
+          "ref": {
+            "kind": "name",
+            "id": "name_input",
+            "label": "input",
+            "name": "input"
+          }
+        },
+        {
+          "name": "factor",
+          "ref": {
+            "kind": "name",
+            "id": "name_factor",
+            "label": "factor",
+            "name": "factor"
+          }
+        }
+      ]
+    }
+  ],
+  "ops": [],
+  "changed": [
+    {
+      "kind": "writeFormula",
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "message": "Write formula to result"
+    }
+  ],
+  "checks": [
+    {
+      "status": "planned",
+      "kind": "exists",
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "message": "result exists"
+    },
+    {
+      "status": "planned",
+      "kind": "formulaEquals",
+      "target": {
+        "kind": "name",
+        "id": "name_result",
+        "label": "result",
+        "name": "result"
+      },
+      "message": "result formula equals (input)*(factor)",
+      "expectation": {
+        "kind": "formulaEquals",
+        "formula": "(input)*(factor)",
+        "inputs": [
+          {
+            "kind": "name",
+            "id": "name_input",
+            "label": "input",
+            "name": "input"
+          },
+          {
+            "kind": "name",
+            "id": "name_factor",
+            "label": "factor",
+            "name": "factor"
+          }
+        ],
+        "labels": [
+          {
+            "name": "input",
+            "ref": {
+              "kind": "name",
+              "id": "name_input",
+              "label": "input",
+              "name": "input"
+            }
+          },
+          {
+            "name": "factor",
+            "ref": {
+              "kind": "name",
+              "id": "name_factor",
+              "label": "factor",
+              "name": "factor"
+            }
+          }
+        ]
+      }
+    }
+  ]
+}