@bilig/headless 0.10.63 → 0.10.64

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.
Files changed (2) hide show
  1. package/README.md +44 -29
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -6,14 +6,46 @@
6
6
  [![GitHub Repo stars](https://img.shields.io/github/stars/proompteng/bilig?style=social)](https://github.com/proompteng/bilig/stargazers)
7
7
  [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](../../LICENSE)
8
8
 
9
- `@bilig/headless` is the production-targeted WorkPaper workbook facade for
10
- `bilig`. It runs the `@bilig/core` spreadsheet engine without the browser UI and
11
- exposes HyperFormula-style workbook workflows for services, tests, agents, and
12
- server-side spreadsheet automation.
9
+ `@bilig/headless` lets Node.js programs build workbooks, write formulas, read
10
+ calculated cells, and save or restore the workbook as JSON. It is the `bilig`
11
+ spreadsheet engine without the browser UI.
13
12
 
14
- Use it when you need a headless spreadsheet engine for Node services, coding
15
- agents, benchmark harnesses, persistence tests, formula-backed business logic,
16
- or local-first workbook automation.
13
+ Use it for service-side spreadsheet calculations, deterministic tests around
14
+ formula-backed business logic, local-first workbook state, and tool-calling
15
+ workflows that need stable cell addresses.
16
+
17
+ ## Install
18
+
19
+ Requires Node `24+` and ESM imports.
20
+
21
+ ```sh
22
+ npm install @bilig/headless
23
+ ```
24
+
25
+ Inside this monorepo:
26
+
27
+ ```sh
28
+ pnpm install
29
+ pnpm --filter @bilig/headless build
30
+ ```
31
+
32
+ ## Start Here
33
+
34
+ - Run the [quickstart](#quickstart) for a one-file formula and persistence
35
+ smoke test.
36
+ - Try the runnable examples:
37
+ [`examples/headless-workpaper`](../../examples/headless-workpaper) and
38
+ [`npm run json-records`](../../examples/headless-workpaper#json-records-input).
39
+ - Build a small service from the
40
+ [Node service recipe](../../docs/node-service-workpaper-recipe.md).
41
+ - Check the
42
+ [compatibility boundaries](../../docs/where-bilig-is-not-excel-compatible-yet.md)
43
+ before assuming full Excel parity.
44
+ - Compare against other engines with the
45
+ [HyperFormula comparison](../../docs/hyperformula-alternative-headless-workpaper.md)
46
+ and [benchmark explainer](../../docs/what-workpaper-benchmark-proves.md).
47
+ - Star or bookmark the project:
48
+ <https://github.com/proompteng/bilig/stargazers>.
17
49
 
18
50
  ## Production Status
19
51
 
@@ -65,21 +97,9 @@ Supported scope:
65
97
  workbook data with the helpers below, then register custom behavior in
66
98
  application code before restore.
67
99
 
68
- ## Requirements
100
+ ## XLSX Import And Export
69
101
 
70
- - Node `24+`
71
- - ESM imports
72
- - `pnpm@10.32.1` for this monorepo
73
-
74
- ## Install
75
-
76
- Published WorkPaper package:
77
-
78
- ```sh
79
- pnpm add @bilig/headless
80
- ```
81
-
82
- XLSX ingestion and export:
102
+ XLSX ingestion and export are developed in this repository:
83
103
 
84
104
  ```sh
85
105
  git clone https://github.com/proompteng/bilig.git
@@ -93,7 +113,7 @@ being provisioned. Until that package is published on npm, use a repository
93
113
  checkout for XLSX import/export work instead of adding `@bilig/excel-import` as
94
114
  an external dependency.
95
115
 
96
- Repository:
116
+ Repository links:
97
117
 
98
118
  - Website: <https://proompteng.github.io/bilig/>
99
119
  - GitHub: <https://github.com/proompteng/bilig>
@@ -105,6 +125,8 @@ Repository:
105
125
  - npm: <https://www.npmjs.com/package/@bilig/headless>
106
126
  - runnable example:
107
127
  [`examples/headless-workpaper`](../../examples/headless-workpaper)
128
+ - JSON records input example:
129
+ [`npm run json-records`](../../examples/headless-workpaper#json-records-input)
108
130
  - Node service recipe:
109
131
  [`docs/node-service-workpaper-recipe.md`](../../docs/node-service-workpaper-recipe.md)
110
132
  - CSV-shaped input recipe:
@@ -134,13 +156,6 @@ Repository:
134
156
  - DEV article source:
135
157
  [`docs/dev-to-workbook-apis-post.md`](../../docs/dev-to-workbook-apis-post.md)
136
158
 
137
- Inside this monorepo:
138
-
139
- ```sh
140
- pnpm install
141
- pnpm --filter @bilig/headless build
142
- ```
143
-
144
159
  ## Quickstart
145
160
 
146
161
  This snippet is safe to paste into a one-file npm evaluation. It verifies formula
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@bilig/headless",
3
- "version": "0.10.63",
4
- "description": "Headless spreadsheet engine and WorkPaper workbook facade for Node services, coding agents, and HyperFormula-style workflows.",
3
+ "version": "0.10.64",
4
+ "description": "Headless spreadsheet engine for Node.js formulas, workbook JSON persistence, and service-side spreadsheet automation.",
5
5
  "keywords": [
6
6
  "agent",
7
7
  "agents",
@@ -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.10.63",
70
- "@bilig/formula": "0.10.63",
71
- "@bilig/protocol": "0.10.63"
69
+ "@bilig/core": "0.10.64",
70
+ "@bilig/formula": "0.10.64",
71
+ "@bilig/protocol": "0.10.64"
72
72
  },
73
73
  "engines": {
74
74
  "node": ">=24.0.0"