@molecule/api-formula-engine 1.0.0

package/LICENSE

@@ -0,0 +1,115 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work.
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work, that is intentionally submitted to the Licensor for
+      inclusion in the Work by the copyright owner or by an individual or
+      Legal Entity authorized to submit on behalf of the copyright owner.
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      patent license to make, have made, use, offer to sell, sell, import,
+      and otherwise transfer the Work.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file.
+
+   5. Submission of Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
+
+   8. Limitation of Liability. In no event and under no legal theory shall
+      any Contributor be liable to You for damages.
+
+   9. Accepting Warranty or Additional Liability.
+
+   Copyright 2026 Molecule Dev, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/browser-guard.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=browser-guard.d.ts.map

package/dist/browser-guard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-guard.d.ts","sourceRoot":"","sources":["../src/browser-guard.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,CAAA"}

package/dist/browser-guard.js

@@ -0,0 +1,18 @@
+/**
+ * Browser guard — `@molecule/api-formula-engine` is SERVER-ONLY.
+ *
+ * Generated by scripts/gen-browser-guards.mjs (workspace root) — edit THAT, not this.
+ * Evaluating a server package in a browser bundle is always an import-graph mistake
+ * (node APIs, secrets); without this guard it surfaces as a cryptic downstream crash
+ * ("Buffer is not defined") far from the culprit. Throwing here names the package and
+ * the fix at the exact moment the client bundle evaluates it. jsdom tests and SSR are
+ * unaffected: the throw requires browser globals AND the absence of a node runtime.
+ */
+const g = globalThis;
+if (g.window !== undefined && g.document !== undefined && !g.process?.versions?.node) {
+    throw new Error('@molecule/api-formula-engine is SERVER-ONLY: it was bundled into browser/client code. Import it only ' +
+        'from server code (a server route/function or your API), or dynamic-import it inside ' +
+        'the server handler — never from components or shared client modules, and never ' +
+        'polyfill Buffer/process to silence this.');
+}
+export {};

package/dist/dependencies.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Dependency-graph helpers used by the Sheet engine for incremental
+ * recompute and circular-reference detection.
+ *
+ * Pure functions — no I/O, no globals.
+ *
+ * @module
+ */
+import { coordKey } from './references.js';
+import type { AstNode, CellCoord } from './types.js';
+/**
+ * Walk an AST and collect every coordinate it references (single
+ * references and every cell inside ranges).
+ *
+ * @param node - Root AST node.
+ * @returns Flat list of referenced coordinates (may contain duplicates).
+ */
+export declare function collectReferences(node: AstNode): CellCoord[];
+/**
+ * Topologically sort a set of coordinate keys by their dependency graph
+ * such that, for any edge `a → b` (b depends on a), `a` precedes `b`
+ * in the result.
+ *
+ * Uses Kahn's algorithm. If a cycle is detected, the cycle members are
+ * returned in `cycle` and excluded from `order` — callers typically
+ * mark cycle members with a `#CIRC!` error.
+ *
+ * @param dependents - Map from a key to the set of keys that depend on it.
+ *   (i.e. forward edges in the recompute order.)
+ * @param keys - Keys to sort.
+ * @returns `{ order, cycle }` — `order` is the topological order;
+ *   `cycle` is the set of keys participating in (or downstream of) a
+ *   cycle.
+ */
+export declare function topologicalSort(dependents: ReadonlyMap<string, ReadonlySet<string>>, keys: ReadonlyArray<string>): {
+    order: string[];
+    cycle: Set<string>;
+};
+/**
+ * Encode a coordinate to its canonical string key. Re-exported from
+ * `references` for convenience.
+ */
+export { coordKey };
+//# sourceMappingURL=dependencies.d.ts.map

package/dist/dependencies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencies.d.ts","sourceRoot":"","sources":["../src/dependencies.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,QAAQ,EAAgB,MAAM,iBAAiB,CAAA;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEpD;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,EAAE,CAI5D;AA4BD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,EACpD,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,GAC1B;IAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAAE,CA8BzC;AAED;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/dist/dependencies.js

@@ -0,0 +1,110 @@
+/**
+ * Dependency-graph helpers used by the Sheet engine for incremental
+ * recompute and circular-reference detection.
+ *
+ * Pure functions — no I/O, no globals.
+ *
+ * @module
+ */
+import { coordKey, iterateRange } from './references.js';
+/**
+ * Walk an AST and collect every coordinate it references (single
+ * references and every cell inside ranges).
+ *
+ * @param node - Root AST node.
+ * @returns Flat list of referenced coordinates (may contain duplicates).
+ */
+export function collectReferences(node) {
+    const acc = [];
+    walk(node, acc);
+    return acc;
+}
+/**
+ * Recursively walk an AST node and push every referenced coordinate into `acc`.
+ */
+function walk(node, acc) {
+    switch (node.kind) {
+        case 'reference':
+            acc.push(node.coord);
+            return;
+        case 'range':
+            for (const c of iterateRange(node.range))
+                acc.push(c);
+            return;
+        case 'unary':
+            walk(node.operand, acc);
+            return;
+        case 'binary':
+            walk(node.left, acc);
+            walk(node.right, acc);
+            return;
+        case 'call':
+            for (const a of node.args)
+                walk(a, acc);
+            return;
+        default:
+            return;
+    }
+}
+/**
+ * Topologically sort a set of coordinate keys by their dependency graph
+ * such that, for any edge `a → b` (b depends on a), `a` precedes `b`
+ * in the result.
+ *
+ * Uses Kahn's algorithm. If a cycle is detected, the cycle members are
+ * returned in `cycle` and excluded from `order` — callers typically
+ * mark cycle members with a `#CIRC!` error.
+ *
+ * @param dependents - Map from a key to the set of keys that depend on it.
+ *   (i.e. forward edges in the recompute order.)
+ * @param keys - Keys to sort.
+ * @returns `{ order, cycle }` — `order` is the topological order;
+ *   `cycle` is the set of keys participating in (or downstream of) a
+ *   cycle.
+ */
+export function topologicalSort(dependents, keys) {
+    const inDegree = new Map();
+    const set = new Set(keys);
+    for (const k of set)
+        inDegree.set(k, 0);
+    for (const k of set) {
+        const outs = dependents.get(k);
+        if (!outs)
+            continue;
+        for (const target of outs) {
+            if (!set.has(target))
+                continue;
+            inDegree.set(target, (inDegree.get(target) ?? 0) + 1);
+        }
+    }
+    const queue = [];
+    for (const [k, d] of inDegree)
+        if (d === 0)
+            queue.push(k);
+    const order = [];
+    while (queue.length > 0) {
+        const k = queue.shift();
+        order.push(k);
+        const outs = dependents.get(k);
+        if (!outs)
+            continue;
+        for (const target of outs) {
+            if (!set.has(target))
+                continue;
+            const next = (inDegree.get(target) ?? 0) - 1;
+            inDegree.set(target, next);
+            if (next === 0)
+                queue.push(target);
+        }
+    }
+    const cycle = new Set();
+    for (const k of set)
+        if (!order.includes(k))
+            cycle.add(k);
+    return { order, cycle };
+}
+/**
+ * Encode a coordinate to its canonical string key. Re-exported from
+ * `references` for convenience.
+ */
+export { coordKey };

package/dist/evaluator.d.ts

@@ -0,0 +1,29 @@
+/**
+ * AST evaluator.
+ *
+ * Walks an AST node and produces a `CellValue`. Cell references are
+ * resolved through a caller-supplied `resolveCell` lookup function so
+ * the evaluator stays decoupled from the underlying sheet storage.
+ *
+ * Pure function — no I/O, no globals.
+ *
+ * @module
+ */
+import type { AstNode, CellCoord, CellValue, EvaluateOptions } from './types.js';
+/**
+ * Function used to resolve a cell coordinate to its value. Returns
+ * `null` for empty cells. Implementations may evaluate dependent
+ * formulas (in which case they should detect cycles and return a
+ * `#CIRC!` error to the caller).
+ */
+export type ResolveCell = (coord: CellCoord) => CellValue;
+/**
+ * Evaluate an AST in the context of a cell-resolution function.
+ *
+ * @param node - Root AST node.
+ * @param resolveCell - Function returning the value of a referenced cell.
+ * @param options - Evaluation options.
+ * @returns Evaluated cell value (errors are returned, not thrown).
+ */
+export declare function evaluate(node: AstNode, resolveCell: ResolveCell, options?: EvaluateOptions): CellValue;
+//# sourceMappingURL=evaluator.d.ts.map

package/dist/evaluator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evaluator.d.ts","sourceRoot":"","sources":["../src/evaluator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAmB,MAAM,YAAY,CAAA;AAGjG;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,SAAS,KAAK,SAAS,CAAA;AAEzD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,OAAO,EACb,WAAW,EAAE,WAAW,EACxB,OAAO,GAAE,eAAoB,GAC5B,SAAS,CAKX"}

package/dist/evaluator.js

@@ -0,0 +1,159 @@
+/**
+ * AST evaluator.
+ *
+ * Walks an AST node and produces a `CellValue`. Cell references are
+ * resolved through a caller-supplied `resolveCell` lookup function so
+ * the evaluator stays decoupled from the underlying sheet storage.
+ *
+ * Pure function — no I/O, no globals.
+ *
+ * @module
+ */
+import { BUILTIN_FUNCTIONS } from './functions.js';
+import { iterateRange } from './references.js';
+import { compareValues, isError, makeError, toNumber, toStringValue } from './values.js';
+/**
+ * Evaluate an AST in the context of a cell-resolution function.
+ *
+ * @param node - Root AST node.
+ * @param resolveCell - Function returning the value of a referenced cell.
+ * @param options - Evaluation options.
+ * @returns Evaluated cell value (errors are returned, not thrown).
+ */
+export function evaluate(node, resolveCell, options = {}) {
+    const ctx = {
+        now: options.now ?? (() => new Date()),
+    };
+    return evalNode(node, resolveCell, ctx);
+}
+/**
+ * Recursively evaluate a single AST node and return its cell value.
+ */
+function evalNode(node, resolveCell, ctx) {
+    switch (node.kind) {
+        case 'number':
+            return node.value;
+        case 'string':
+            return node.value;
+        case 'boolean':
+            return node.value;
+        case 'errorLiteral':
+            return makeError(node.code);
+        case 'reference':
+            return resolveCell(node.coord);
+        case 'range':
+            // A range used outside a function context coerces to its first cell.
+            return resolveCell(node.range.start);
+        case 'unary':
+            return evalUnary(node.op, evalNode(node.operand, resolveCell, ctx));
+        case 'binary':
+            return evalBinary(node.op, evalNode(node.left, resolveCell, ctx), evalNode(node.right, resolveCell, ctx));
+        case 'call':
+            return evalCall(node.name, node.args, resolveCell, ctx);
+    }
+}
+/**
+ * Apply a unary operator (`+`, `-`, `%`) to a cell value and return the result.
+ */
+function evalUnary(op, operand) {
+    if (isError(operand))
+        return operand;
+    const n = toNumber(operand);
+    if (isError(n))
+        return n;
+    switch (op) {
+        case '+':
+            return n;
+        case '-':
+            return -n;
+        case '%':
+            return n / 100;
+    }
+}
+/**
+ * Apply a binary operator to two cell values and return the result.
+ */
+function evalBinary(op, left, right) {
+    if (isError(left))
+        return left;
+    if (isError(right))
+        return right;
+    if (op === '&') {
+        const l = toStringValue(left);
+        if (isError(l))
+            return l;
+        const r = toStringValue(right);
+        if (isError(r))
+            return r;
+        return l + r;
+    }
+    if (op === '=' || op === '<>' || op === '<' || op === '<=' || op === '>' || op === '>=') {
+        const cmp = compareValues(left, right);
+        if (isError(cmp))
+            return cmp;
+        switch (op) {
+            case '=':
+                return cmp === 0;
+            case '<>':
+                return cmp !== 0;
+            case '<':
+                return cmp < 0;
+            case '<=':
+                return cmp <= 0;
+            case '>':
+                return cmp > 0;
+            case '>=':
+                return cmp >= 0;
+        }
+    }
+    // Arithmetic
+    const l = toNumber(left);
+    if (isError(l))
+        return l;
+    const r = toNumber(right);
+    if (isError(r))
+        return r;
+    switch (op) {
+        case '+':
+            return l + r;
+        case '-':
+            return l - r;
+        case '*':
+            return l * r;
+        case '/':
+            if (r === 0)
+                return makeError('#DIV/0!');
+            return l / r;
+        case '^': {
+            const v = l ** r;
+            if (!Number.isFinite(v))
+                return makeError('#NUM!');
+            return v;
+        }
+        default:
+            return makeError('#VALUE!', `Unknown operator: ${op}`);
+    }
+}
+/**
+ * Look up and invoke a built-in function by name, expanding range arguments into arrays.
+ */
+function evalCall(name, argNodes, resolveCell, ctx) {
+    const fn = BUILTIN_FUNCTIONS[name];
+    if (!fn)
+        return makeError('#NAME?', `Unknown function: ${name}`);
+    // Evaluate each argument: ranges expand into arrays.
+    const args = [];
+    for (const arg of argNodes) {
+        if (arg.kind === 'range') {
+            const expanded = [];
+            for (const c of iterateRange(arg.range)) {
+                expanded.push(resolveCell(c));
+            }
+            args.push(expanded);
+        }
+        else {
+            args.push(evalNode(arg, resolveCell, ctx));
+        }
+    }
+    return fn(args, ctx);
+}

package/dist/functions.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Built-in function registry.
+ *
+ * Each entry is a pure function: given a list of evaluated argument
+ * values (scalars or expanded ranges), returns a `CellValue`.
+ *
+ * Implements: SUM, AVERAGE/AVG, MIN, MAX, COUNT, COUNTA, COUNTIF,
+ * SUMIF, IF, AND, OR, NOT, IFS, SWITCH, IFERROR, ISERROR, ISNUMBER,
+ * ISBLANK, CONCAT/CONCATENATE, LEFT, RIGHT, MID, LEN, TRIM, UPPER,
+ * LOWER, SUBSTITUTE, ROUND, ABS, MOD, POWER, SQRT, INT, CEILING,
+ * FLOOR, DATE, TODAY, NOW, YEAR, MONTH, DAY, DATEDIF / DATEDIFF.
+ *
+ * @module
+ */
+import type { FormulaFunction } from './types.js';
+/**
+ * Map of function names (uppercase) to implementations. Aliases like
+ * `AVG → AVERAGE` and `DATEDIF → DATEDIFF` map to the same function
+ * reference.
+ */
+export declare const BUILTIN_FUNCTIONS: Readonly<Record<string, FormulaFunction>>;
+//# sourceMappingURL=functions.d.ts.map

package/dist/functions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../src/functions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EAAa,eAAe,EAAmB,MAAM,YAAY,CAAA;AA6nB7E;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CA8CtE,CAAA"}