@truecalc/core 7.0.5 → 7.0.7

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": "7.0.5",
+  "version": "7.0.7",
   "license": "MIT",
   "repository": {
     "type": "git",

package/truecalc_wasm.d.ts

@@ -22,6 +22,81 @@ export interface SparklineSpecResult {
     options: [string, EvalResult][];
 }
 
+/**
+ * Metadata for one built-in function, as returned by [`list_functions`].
+ *
+ * Derived from the engine\'s function registry, so it always reflects what the
+ * engine actually implements.
+ */
+export interface FunctionInfo {
+    /**
+     * The function name in upper case, e.g. `\"SUM\"`.
+     */
+    name: string;
+    /**
+     * The registry category, e.g. `\"math\"`, `\"text\"`, `\"financial\"`.
+     */
+    category: string;
+    /**
+     * The call signature, e.g. `\"PMT(rate, nper, pv, [fv], [type])\"`.
+     * Optional arguments appear in square brackets.
+     */
+    syntax: string;
+    /**
+     * A one-line description of what the function does.
+     */
+    description: string;
+}
+
+/**
+ * The outcome of a [`rename_sheet_refs`] call.
+ *
+ * Exactly one of `formula` or `error` is present.
+ */
+export interface RenameSheetRefsResult {
+    /**
+     * The rewritten formula. Absent when the input failed to parse.
+     */
+    formula?: string;
+    /**
+     * The parse error message. Absent on success.
+     */
+    error?: string;
+}
+
+/**
+ * The outcome of a [`translate_formula`] call.
+ *
+ * Exactly one of `formula` or `error` is present.
+ */
+export interface TranslateResult {
+    /**
+     * The rewritten formula. Absent when the input failed to parse.
+     */
+    formula?: string;
+    /**
+     * The parse error message. Absent on success.
+     */
+    error?: string;
+}
+
+/**
+ * The outcome of a [`validate`] call.
+ *
+ * `{ valid: true }` when the formula parses, otherwise
+ * `{ valid: false, error: \"...\" }`.
+ */
+export interface ValidateResult {
+    /**
+     * `true` when the formula parses.
+     */
+    valid: boolean;
+    /**
+     * The parse error message. Absent when `valid` is `true`.
+     */
+    error?: string;
+}
+
 /**
  * The result of evaluating a formula on the WASM surface.
  *
@@ -49,28 +124,6 @@ export interface SparklineSpecResult {
  */
 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;
-    category: string;
-    syntax: string;
-    description: string;
-}
-
-export interface RenameSheetRefsResult {
-    formula?: string;
-    error?: string;
-}
-
-export interface TranslateResult {
-    formula?: string;
-    error?: string;
-}
-
-export interface ValidateResult {
-    valid: boolean;
-    error?: string;
-}
-
 
 /**
  * A stateful engine bound to a conformance target.