@truecalc/core 6.0.1 → 7.0.0

package/package.json

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

package/truecalc_wasm.d.ts

@@ -1,5 +1,27 @@
 /* tslint:disable */
 /* eslint-disable */
+/**
+ * A parsed sparkline render spec on the WASM surface. `data` points and
+ * option values are ordinary [`EvalResult`] cells (a blank cell inside the
+ * source range is `empty`).
+ */
+export interface SparklineSpecResult {
+    /**
+     * `line` (the default), `bar`, `column` or `winloss`.
+     */
+    charttype: string;
+    /**
+     * The points to plot, row-major.
+     */
+    data: EvalResult[];
+    /**
+     * The remaining option key/value pairs, in the order given, keys
+     * lower-cased. Keys the engine does not recognise are kept, not rejected:
+     * Sheets ignores an unknown option key rather than erroring.
+     */
+    options: [string, EvalResult][];
+}
+
 /**
  * The result of evaluating a formula on the WASM surface.
  *
@@ -25,7 +47,7 @@
  * - `{ 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: "zoned"; value: string } | { type: "error"; error: string; message?: string } | { type: "empty" } | { type: "array"; value: EvalResult[] };
+export type EvalResult = { type: "number"; value: number } | { type: "text"; value: string } | { type: "bool"; value: boolean } | { type: "date"; value: number } | { type: "zoned"; value: string } | { type: "error"; error: string; message?: string } | { type: "empty" } | { type: "array"; value: EvalResult[] } | { type: "sparkline"; value: SparklineSpecResult };
 
 export interface FunctionInfo {
     name: string;
@@ -34,6 +56,11 @@ export interface FunctionInfo {
     description: string;
 }
 
+export interface RenameSheetRefsResult {
+    formula?: string;
+    error?: string;
+}
+
 export interface TranslateResult {
     formula?: string;
     error?: string;
@@ -83,6 +110,16 @@ export function evaluate(formula: string, variables: any): EvalResult;
  */
 export function list_functions(): FunctionInfo[];
 
+/**
+ * Rewrite the sheet qualifier of every cell/range reference in `formula`
+ * that points at `old` to point at `new` instead — the sheet-rename
+ * reference-rewrite transform. Sheet-name matching is case-insensitive.
+ * Requoting is handled automatically. Unqualified refs, refs to other
+ * sheets, string literals, function names, and defined names are left
+ * untouched; no-op if `formula` has no `old`-qualified refs.
+ */
+export function rename_sheet_refs(formula: string, old: string, _new: string): RenameSheetRefsResult;
+
 /**
  * Shift every relative cell/range reference in `formula` by `(d_row, d_col)`
  * — the fill / copy-paste reference-adjustment transform. `$`-absolute axes

package/truecalc_wasm.js

@@ -5,5 +5,5 @@ import { __wbg_set_wasm } from "./truecalc_wasm_bg.js";
 __wbg_set_wasm(wasm);
 
 export {
-    Engine, createEngine, evaluate, list_functions, translate_formula, validate
+    Engine, createEngine, evaluate, list_functions, rename_sheet_refs, translate_formula, validate
 } from "./truecalc_wasm_bg.js";

package/truecalc_wasm_bg.js

@@ -98,6 +98,29 @@ export function list_functions() {
     }
 }
 
+/**
+ * Rewrite the sheet qualifier of every cell/range reference in `formula`
+ * that points at `old` to point at `new` instead — the sheet-rename
+ * reference-rewrite transform. Sheet-name matching is case-insensitive.
+ * Requoting is handled automatically. Unqualified refs, refs to other
+ * sheets, string literals, function names, and defined names are left
+ * untouched; no-op if `formula` has no `old`-qualified refs.
+ * @param {string} formula
+ * @param {string} old
+ * @param {string} _new
+ * @returns {RenameSheetRefsResult}
+ */
+export function rename_sheet_refs(formula, old, _new) {
+    const ptr0 = passStringToWasm0(formula, wasm.__wbindgen_export, wasm.__wbindgen_export2);
+    const len0 = WASM_VECTOR_LEN;
+    const ptr1 = passStringToWasm0(old, wasm.__wbindgen_export, wasm.__wbindgen_export2);
+    const len1 = WASM_VECTOR_LEN;
+    const ptr2 = passStringToWasm0(_new, wasm.__wbindgen_export, wasm.__wbindgen_export2);
+    const len2 = WASM_VECTOR_LEN;
+    const ret = wasm.rename_sheet_refs(ptr0, len0, ptr1, len1, ptr2, len2);
+    return takeObject(ret);
+}
+
 /**
  * Shift every relative cell/range reference in `formula` by `(d_row, d_col)`
  * — the fill / copy-paste reference-adjustment transform. `$`-absolute axes