@truecalc/core 0.6.4 → 0.8.0

package/README.md

@@ -79,15 +79,57 @@ evaluate('CONCAT("Hello, ", name)', { name: 'world' })
 // => { type: 'text', value: 'Hello, world' }
 ```
 
-**Return value shape:**
-
-| `type`    | Shape                                |
-|-----------|--------------------------------------|
-| `number`  | `{ type: 'number', value: 6 }`       |
-| `text`    | `{ type: 'text', value: 'yes' }`     |
-| `boolean` | `{ type: 'boolean', value: true }`   |
-| `error`   | `{ type: 'error', error: '#NAME?' }` |
-| `empty`   | `{ type: 'empty', value: null }`     |
+**Return value shape** (a discriminated union tagged by `type`):
+
+| `type`   | Shape                                                  |
+|----------|--------------------------------------------------------|
+| `number` | `{ type: 'number', value: 6 }`                         |
+| `text`   | `{ type: 'text', value: 'yes' }`                       |
+| `bool`   | `{ type: 'bool', value: true }`                        |
+| `date`   | `{ type: 'date', value: 46180 }`                       |
+| `error`  | `{ type: 'error', error: '#NAME?' }`                   |
+| `empty`  | `{ type: 'empty' }`                                    |
+| `array`  | `{ type: 'array', value: [ /* EvalResult cells */ ] }` |
+
+`date` carries a spreadsheet **serial number** (`value`); the epoch is implied by
+the engine flavor (`google-sheets`: day 0 = 1899-12-30). Format it yourself if you
+need a calendar date.
+
+`array` is **recursive**: each element is itself an `EvalResult`, so a 1-D result is
+a flat `value` list of scalar cells and a 2-D result is a `value` list of `array`
+rows whose elements are scalar cells. Array cells keep their own type (including
+nested `date`/`error`/`empty`).
+
+```js
+evaluate('SEQUENCE(2,2)')
+// => {
+//   type: 'array',
+//   value: [
+//     { type: 'array', value: [ { type: 'number', value: 1 }, { type: 'number', value: 2 } ] },
+//     { type: 'array', value: [ { type: 'number', value: 3 }, { type: 'number', value: 4 } ] },
+//   ],
+// }
+
+evaluate('TODAY()')
+// => { type: 'date', value: 46180 }
+```
+
+> #### Breaking change in 0.7.0 (surface shape)
+>
+> 0.7.0 ships the unspilled-array core change (see core PR #566 / issue #569).
+> Two observable shapes changed for npm consumers:
+>
+> - **Array-producing formulas** (`SORT`, `FILTER`, `UNIQUE`, `SEQUENCE`,
+>   `TRANSPOSE`, `MMULT`, `HSTACK`/`VSTACK`, `RANDARRAY`, array literals, ...) now
+>   return a full `{ type: 'array', value: [...] }` result. In `<= 0.6.x` these
+>   returned the top-left anchor-cell **scalar** (and, transiently after #566 but
+>   before this fix, an `{ type: 'error', error: 'array not supported' }` object).
+>   To recover the old single-cell behavior, read the first cell yourself, e.g.
+>   `const tl = r.type === 'array' ? r.value[0] : r;` (recurse once more for 2-D).
+> - **Date-producing functions** (`TODAY`, `DATE`, ...) now return
+>   `{ type: 'date', value }` instead of `{ type: 'number', value }`. If you were
+>   treating the result as a number, also accept `type === 'date'` (the `value`
+>   encoding is identical — a serial number).
 
 ### `validate(formula)`
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@truecalc/core",
   "type": "module",
   "description": "Spreadsheet formula engine for the browser — Excel-compatible formula evaluator compiled to WebAssembly",
-  "version": "0.6.4",
+  "version": "0.8.0",
   "license": "MIT",
   "repository": {
     "type": "git",

package/truecalc_wasm.d.ts

@@ -1,5 +1,29 @@
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * The result of evaluating a formula on the WASM surface.
+ *
+ * A discriminated union tagged by `type`. Scalars carry their value directly;
+ * the `array` variant is recursive -- each element is itself an `EvalResult`,
+ * so a 2-D array result is an array of `array` rows whose elements are scalar
+ * `EvalResult`s. This mirrors how `truecalc-core` represents array values
+ * internally (1-D arrays are flat, 2-D arrays nest row sub-arrays) and matches
+ * the recursive shape `truecalc-mcp` already emits.
+ *
+ * # Surface shape (npm `@truecalc/core` >= 0.7.0)
+ *
+ * - `{ type: \"number\", value: 1.5 }`
+ * - `{ type: \"text\", value: \"yes\" }`
+ * - `{ type: \"bool\", value: true }`
+ * - `{ type: \"empty\" }`
+ * - `{ type: \"error\", error: \"#REF!\" }`
+ * - `{ type: \"date\", value: 46180 }` -- spreadsheet serial number (epoch implied
+ *   by the engine flavor; `sheets` day 0 = 1899-12-30)
+ * - `{ type: \"array\", value: [ EvalResult, ... ] }` -- recursive; a 2-D result is
+ *   `{ type: \"array\", value: [ { type: \"array\", value: [ <cells> ] }, ... ] }`
+ */
+export type EvalResult = { type: "number"; value: number } | { type: "text"; value: string } | { type: "bool"; value: boolean } | { type: "date"; value: number } | { type: "error"; error: string } | { type: "empty" } | { type: "array"; value: EvalResult[] };
+
 export interface FunctionInfo {
     name: string;
     category: string;
@@ -12,8 +36,6 @@ export interface ValidateResult {
     error?: string;
 }
 
-export type EvalResult = { type: "number"; value: number } | { type: "text"; value: string } | { type: "bool"; value: boolean } | { type: "error"; error: string } | { type: "empty" };
-
 
 /**
  * A stateful engine bound to a conformance target.

package/truecalc_wasm_bg.js

@@ -115,6 +115,13 @@ export function __wbg_Error_960c155d3d49e4c2(arg0, arg1) {
     const ret = Error(getStringFromWasm0(arg0, arg1));
     return addHeapObject(ret);
 }
+export function __wbg_String_8564e559799eccda(arg0, arg1) {
+    const ret = String(getObject(arg1));
+    const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_export, wasm.__wbindgen_export2);
+    const len1 = WASM_VECTOR_LEN;
+    getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
+    getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
+}
 export function __wbg___wbindgen_bigint_get_as_i64_3d3aba5d616c6a51(arg0, arg1) {
     const v = getObject(arg1);
     const ret = typeof(v) === 'bigint' ? v : undefined;
@@ -253,6 +260,10 @@ export function __wbg_new_0c7403db6e782f19(arg0) {
     const ret = new Uint8Array(getObject(arg0));
     return addHeapObject(ret);
 }
+export function __wbg_new_682678e2f47e32bc() {
+    const ret = new Array();
+    return addHeapObject(ret);
+}
 export function __wbg_new_aa8d0fa9762c29bd() {
     const ret = new Object();
     return addHeapObject(ret);
@@ -268,6 +279,9 @@ export function __wbg_next_7646edaa39458ef7(arg0) {
 export function __wbg_prototypesetcall_a6b02eb00b0f4ce2(arg0, arg1, arg2) {
     Uint8Array.prototype.set.call(getArrayU8FromWasm0(arg0, arg1), getObject(arg2));
 }
+export function __wbg_set_3bf1de9fab0cd644(arg0, arg1, arg2) {
+    getObject(arg0)[arg1 >>> 0] = takeObject(arg2);
+}
 export function __wbg_set_6be42768c690e380(arg0, arg1, arg2) {
     getObject(arg0)[takeObject(arg1)] = takeObject(arg2);
 }