@bilig/headless 0.11.27 → 0.11.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -54
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -6,13 +6,17 @@
|
|
|
6
6
|
[](https://github.com/proompteng/bilig/stargazers)
|
|
7
7
|
[](https://github.com/proompteng/bilig/blob/main/LICENSE)
|
|
8
8
|
|
|
9
|
-
`@bilig/headless`
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
`@bilig/headless` is the `bilig` spreadsheet engine without the browser UI.
|
|
10
|
+
It lets Node.js programs build workbooks, write formulas, read calculated
|
|
11
|
+
cells, and save or restore the workbook as JSON.
|
|
12
12
|
|
|
13
|
-
Use it
|
|
14
|
-
|
|
15
|
-
|
|
13
|
+
Use it when spreadsheet logic belongs inside a service, test suite, local-first
|
|
14
|
+
app, queue worker, or coding-agent tool. It gives code a workbook boundary with
|
|
15
|
+
stable sheet names, cell addresses, formulas, and persisted state.
|
|
16
|
+
|
|
17
|
+
It is not Excel desktop automation and it is not a visual grid. XLSX import and
|
|
18
|
+
export live in the repository import/export packages; this package executes the
|
|
19
|
+
validated WorkPaper model once data is in workbook form.
|
|
16
20
|
|
|
17
21
|
## Install
|
|
18
22
|
|
|
@@ -71,55 +75,34 @@ pnpm --filter @bilig/headless build
|
|
|
71
75
|
|
|
72
76
|
## Start Here
|
|
73
77
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
[
|
|
82
|
-
|
|
83
|
-
[`npm run json-
|
|
84
|
-
|
|
85
|
-
[`npm run
|
|
86
|
-
|
|
87
|
-
[`
|
|
88
|
-
|
|
89
|
-
[`npm run snapshot-diff`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#snapshot-diff)
|
|
90
|
-
for before/after persisted-state comparison, or
|
|
91
|
-
[`npm run range-readback`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#range-readback)
|
|
92
|
-
for computed values and serialized formulas from the same range, or
|
|
93
|
-
[`npm run sheet-inspection`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#sheet-inspection)
|
|
94
|
-
for checking restored workbook shape before writes, or
|
|
95
|
-
[`npm run http-json-summary`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#http-json-summary)
|
|
96
|
-
for a no-framework Node HTTP boundary, or
|
|
97
|
-
[`npm run invoice-totals`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#invoice-totals)
|
|
98
|
-
for subtotal, tax, and total formula readback, or
|
|
99
|
-
[`npm run budget-variance`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#budget-variance-alerts)
|
|
100
|
-
for formula-backed budget variance alerts, or
|
|
101
|
-
[`npm run subscription-mrr`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#subscription-mrr-forecast)
|
|
102
|
-
for churn, expansion, and ending MRR formulas, or
|
|
103
|
-
[`npm run quote-approval`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#quote-approval-threshold)
|
|
104
|
-
for formula-backed quote discount approvals, or
|
|
105
|
-
[`npm run fulfillment-capacity`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#fulfillment-capacity-plan)
|
|
106
|
-
for order volume, labor hours, and capacity gap formulas.
|
|
107
|
-
- Run the
|
|
108
|
-
[serverless WorkPaper API example](https://github.com/proompteng/bilig/tree/main/examples/serverless-workpaper-api)
|
|
109
|
-
when the workbook belongs behind an HTTP or agent-tool boundary.
|
|
110
|
-
- Build a small service from the
|
|
111
|
-
[Node service recipe](https://github.com/proompteng/bilig/blob/main/docs/node-service-workpaper-recipe.md).
|
|
112
|
-
- Put the same workbook boundary behind a
|
|
113
|
-
[serverless API route](https://github.com/proompteng/bilig/blob/main/docs/serverless-workpaper-api-route.md).
|
|
114
|
-
- Check the
|
|
115
|
-
[compatibility boundaries](https://github.com/proompteng/bilig/blob/main/docs/where-bilig-is-not-excel-compatible-yet.md)
|
|
116
|
-
before assuming full Excel parity.
|
|
117
|
-
- Compare against other engines with the
|
|
78
|
+
Pick the path that matches the job:
|
|
79
|
+
|
|
80
|
+
- Prove the package works from npm:
|
|
81
|
+
[clean npm sanity check](#clean-npm-sanity-check).
|
|
82
|
+
- Decide if this package fits a backend formula workload:
|
|
83
|
+
[Node.js spreadsheet formula engine guide](https://proompteng.github.io/bilig/node-spreadsheet-formula-engine.html).
|
|
84
|
+
- Test formula edits plus persistence:
|
|
85
|
+
[quickstart](#quickstart).
|
|
86
|
+
- Convert API records into workbook output:
|
|
87
|
+
[`npm run json-records`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#json-records-input).
|
|
88
|
+
- Wrap workbook edits as agent tools:
|
|
89
|
+
[`npm run agent:tool-call`](https://github.com/proompteng/bilig/tree/main/examples/headless-workpaper#agent-tool-call-loop).
|
|
90
|
+
- Put WorkPaper behind HTTP:
|
|
91
|
+
[`examples/serverless-workpaper-api`](https://github.com/proompteng/bilig/tree/main/examples/serverless-workpaper-api).
|
|
92
|
+
- Compare engines before adopting:
|
|
118
93
|
[SheetJS and ExcelJS comparison](https://github.com/proompteng/bilig/blob/main/docs/sheetjs-exceljs-alternative-formula-workbook-api.md),
|
|
119
|
-
[HyperFormula comparison](https://github.com/proompteng/bilig/blob/main/docs/hyperformula-alternative-headless-workpaper.md)
|
|
120
|
-
and
|
|
121
|
-
-
|
|
122
|
-
|
|
94
|
+
[HyperFormula comparison](https://github.com/proompteng/bilig/blob/main/docs/hyperformula-alternative-headless-workpaper.md),
|
|
95
|
+
and
|
|
96
|
+
[benchmark explainer](https://github.com/proompteng/bilig/blob/main/docs/what-workpaper-benchmark-proves.md).
|
|
97
|
+
|
|
98
|
+
For more workflows, read the
|
|
99
|
+
[five Node workbook automation examples](https://github.com/proompteng/bilig/blob/main/docs/workbook-automation-examples-node.md),
|
|
100
|
+
the [Node service recipe](https://github.com/proompteng/bilig/blob/main/docs/node-service-workpaper-recipe.md),
|
|
101
|
+
the [serverless API route walkthrough](https://github.com/proompteng/bilig/blob/main/docs/serverless-workpaper-api-route.md),
|
|
102
|
+
and the
|
|
103
|
+
[compatibility boundaries](https://github.com/proompteng/bilig/blob/main/docs/where-bilig-is-not-excel-compatible-yet.md).
|
|
104
|
+
|
|
105
|
+
Star or bookmark the project: <https://github.com/proompteng/bilig>.
|
|
123
106
|
|
|
124
107
|
## Which Example Should I Run?
|
|
125
108
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bilig/headless",
|
|
3
|
-
"version": "0.11.
|
|
3
|
+
"version": "0.11.29",
|
|
4
4
|
"description": "Headless spreadsheet engine for Node.js formulas, workbook JSON persistence, and service-side spreadsheet automation.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"agent",
|
|
@@ -66,9 +66,9 @@
|
|
|
66
66
|
"build": "rm -rf dist tsconfig.tsbuildinfo && tsc -p tsconfig.json"
|
|
67
67
|
},
|
|
68
68
|
"dependencies": {
|
|
69
|
-
"@bilig/core": "0.11.
|
|
70
|
-
"@bilig/formula": "0.11.
|
|
71
|
-
"@bilig/protocol": "0.11.
|
|
69
|
+
"@bilig/core": "0.11.29",
|
|
70
|
+
"@bilig/formula": "0.11.29",
|
|
71
|
+
"@bilig/protocol": "0.11.29"
|
|
72
72
|
},
|
|
73
73
|
"engines": {
|
|
74
74
|
"node": ">=24.0.0"
|