@mog-sdk/node 0.1.2 → 0.1.7

package/llms.txt

@@ -0,0 +1,96 @@
+# @mog-sdk/node
+
+Headless spreadsheet engine for Node.js. Full Excel-compatible compute (582 formula functions), XLSX import/export, charts, tables, pivots, conditional formatting — all powered by a native Rust engine.
+
+## API Discovery
+
+This SDK includes a built-in introspection API. Use it to explore the full API surface programmatically — no need to read type definitions:
+
+```typescript
+import { api } from '@mog-sdk/node';
+
+// Overview: list all methods and sub-APIs
+api.describe()
+// → { workbook: { methods: [...], subApis: ['sheets','history','names',...] },
+//     worksheet: { methods: [...], subApis: ['charts','formats','tables',...] } }
+
+// Drill into a sub-API
+api.describe('ws.charts')
+// → { name: 'WorksheetCharts', methods: [{ name: 'add', signature: '...', tags: ['action'] }, ...] }
+
+// Get a specific method with full type info
+api.describe('ws.charts.add')
+// → { name: 'add', signature: '...', tags: ['action'], types: { ChartConfig: { definition: '...' } } }
+
+// Direct methods on root interfaces
+api.describe('ws.setCell')
+api.describe('wb.batch')
+
+// Look up a type definition
+api.describe('type:ChartType')
+```
+
+Paths use `wb.*` for workbook and `ws.*` for worksheet. Sub-APIs are accessed as `ws.{subApi}.{method}`.
+
+## Quick Start
+
+```typescript
+import { createWorkbook } from '@mog-sdk/node';
+
+const wb = await createWorkbook();
+const ws = wb.activeSheet;
+
+// Write cells (formulas auto-recalc)
+await ws.setCell('A1', 100);
+await ws.setCell('A2', 200);
+await ws.setCell('A3', '=SUM(A1:A2)');
+console.log(await ws.getValue('A3')); // 300
+
+// Bulk write
+await ws.setRange('B1', [['Name', 'Score'], ['Alice', 92], ['Bob', 85]]);
+
+// Read
+const data = await ws.getData();           // CellValue[][]
+const csv = await ws.toCSV();              // RFC 4180 CSV string
+const json = await ws.toJSON();            // [{ Name: 'Alice', Score: 92 }, ...]
+await ws.describeRange('A1:B3');           // LLM-friendly text summary
+
+// Always dispose when done
+await wb.dispose();
+```
+
+## Import XLSX
+
+```typescript
+import { createWorkbook } from '@mog-sdk/node';
+import { readFileSync } from 'fs';
+
+const wb = await createWorkbook({
+  source: { type: 'bytes', data: readFileSync('data.xlsx') }
+});
+```
+
+## Sub-API Examples
+
+```typescript
+// Sheets
+await wb.sheets.add('Sheet2');
+await wb.sheets.rename(sheetId, 'Sales');
+
+// Tables
+await ws.tables.add('Sales', 'A1:C10', { hasHeaders: true });
+
+// Charts
+await ws.charts.add({ type: 'bar', dataRange: 'A1:B5' });
+
+// Formatting
+await ws.formats.setCellFormat('A1', { bold: true, fontColor: '#FF0000' });
+
+// Structure
+await ws.structure.insertRows(5, 3);
+await ws.structure.mergeCells('A1:B1');
+
+// History
+await wb.history.undo();
+await wb.history.redo();
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mog-sdk/node",
-  "version": "0.1.2",
+  "version": "0.1.7",
   "description": "Headless spreadsheet engine for Node.js — full Excel-compatible compute, formulas, and file I/O",
   "type": "module",
   "main": "dist/index.cjs",
@@ -19,13 +19,15 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "llms.txt"
   ],
   "engines": {
     "node": ">= 18"
   },
   "scripts": {
-    "build": "tsup && node scripts/build-types.mjs",
+    "generate:api-spec": "tsx scripts/generate-api-spec.ts",
+    "build": "tsx scripts/generate-api-spec.ts && tsup && node scripts/build-types.mjs",
     "build:dev": "tsup --no-dts",
     "test": "jest --config jest.config.cjs",
     "typecheck": "tsc --noEmit",
@@ -51,11 +53,8 @@
     "access": "public"
   },
   "optionalDependencies": {
-    "@mog-sdk/darwin-arm64": "0.1.0",
-    "@mog-sdk/darwin-x64": "0.1.0",
-    "@mog-sdk/linux-x64-gnu": "0.1.0",
-    "@mog-sdk/linux-arm64-gnu": "0.1.0",
-    "@mog-sdk/win32-x64-msvc": "0.1.0"
+    "@mog-sdk/darwin-arm64": "workspace:*",
+    "@mog-sdk/darwin-x64": "workspace:*"
   },
   "devDependencies": {
     "@rust-bridge/client": "workspace:*",