@ricsam/formula-engine 0.0.1

package/dist/types/functions/math/average/averageifs.d.ts

@@ -0,0 +1,21 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * AVERAGEIFS function - Calculates the average of cells in a range that meet multiple criteria
+ *
+ * Usage: AVERAGEIFS(average_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)
+ *
+ * average_range: The range of cells to average
+ * criteria_range1: The first range to evaluate against criteria1
+ * criteria1: The first criteria to match against
+ * criteria_range2, criteria2: Optional additional criteria pairs
+ *
+ * Examples:
+ *   AVERAGEIFS(B1:B10, A1:A10, "Apple") - averages B1:B10 where A1:A10 = "Apple"
+ *   AVERAGEIFS(C1:C10, A1:A10, "Apple", B1:B10, ">10") - averages C1:C10 where A1:A10 = "Apple" AND B1:B10 > 10
+ *
+ * Note:
+ * - All criteria must be satisfied for a value to be included
+ * - Only numeric values are included in the average calculation
+ * - Returns error if no values match all criteria
+ */
+export declare const AVERAGEIFS: FunctionDefinition;

package/dist/types/functions/math/average/averageifs.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/ceiling/ceiling.d.ts

@@ -0,0 +1,5 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * CEILING function implementation
+ */
+export declare const CEILING: FunctionDefinition;

package/dist/types/functions/math/ceiling/ceiling.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/max/max-utils.d.ts

@@ -0,0 +1,20 @@
+import { type FunctionEvaluationResult, type SingleEvaluationResult, type CellInfinity } from "src/core/types";
+import type { EvaluationContext } from "src/evaluator/evaluation-context";
+/**
+ * Result type for processInfinity in max functions
+ */
+export type ProcessInfinityResult<T> = {
+    type: "infinity";
+    infinity: CellInfinity;
+} | {
+    type: "state";
+    state: T;
+};
+/**
+ * Perform maximum calculation over an iterator of SingleEvaluationResults
+ * Handles the common logic shared by MAX, MAXIF, MAXIFS functions
+ *
+ * @param results - Iterator of SingleEvaluationResults to find maximum from
+ * @returns FunctionEvaluationResult with the maximum, infinity, or error
+ */
+export declare function performMaximum(results: Iterable<SingleEvaluationResult>, context: EvaluationContext): FunctionEvaluationResult;

package/dist/types/functions/math/max/max.d.ts

@@ -0,0 +1,18 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * MAX function - Returns the largest number in the arguments
+ *
+ * Usage: MAX(value1, [value2], ...)
+ *
+ * Examples:
+ *   MAX(1, 2, 3) - returns 3
+ *   MAX(A1:A10) - finds maximum in the range A1:A10
+ *   MAX(A1:A5, B1:B5) - finds maximum across both ranges
+ *
+ * Note:
+ * - Only numeric values are considered
+ * - Text, logical values, and empty cells are ignored in ranges
+ * - Direct text/logical arguments cause errors
+ * - Returns error if no numeric values are found
+ */
+export declare const MAX: FunctionDefinition;

package/dist/types/functions/math/max/max.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/max/maxif.d.ts

@@ -0,0 +1,23 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * MAXIF function - Returns the maximum value among cells specified by a criteria
+ *
+ * Usage: MAXIF(range, criteria, [max_range])
+ *
+ * range: The range of cells to evaluate against the criteria
+ * criteria: The criteria to match against. Can be:
+ *   - Exact value: "Apple", 42
+ *   - Comparison: ">10", "<=5", "<>0"
+ *   - Wildcards: "App*", "?ruit"
+ * max_range: Optional. The range to find maximum from. If omitted, uses the range parameter
+ *
+ * Examples:
+ *   MAXIF(A1:A10, "Apple") - max of cells in A1:A10 that contain "Apple"
+ *   MAXIF(B1:B10, ">10") - max of cells in B1:B10 with values greater than 10
+ *   MAXIF(A1:A10, "Apple", B1:B10) - max of B1:B10 where A1:A10 contains "Apple"
+ *
+ * Note:
+ * - Only numeric values are considered for the maximum
+ * - Returns error if no values match the criteria
+ */
+export declare const MAXIF: FunctionDefinition;

package/dist/types/functions/math/max/maxif.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/max/maxifs.d.ts

@@ -0,0 +1,21 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * MAXIFS function - Returns the maximum value among cells specified by multiple criteria
+ *
+ * Usage: MAXIFS(max_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)
+ *
+ * max_range: The range of cells from which you want the maximum
+ * criteria_range1: The first range in which to evaluate criteria
+ * criteria1: The criteria to apply to criteria_range1
+ * criteria_range2, criteria2: Optional additional criteria pairs
+ *
+ * Examples:
+ *   MAXIFS(B1:B10, A1:A10, "Apple") - max of B1:B10 where A1:A10 = "Apple"
+ *   MAXIFS(C1:C10, A1:A10, "Apple", B1:B10, ">10") - max of C1:C10 where A1:A10 = "Apple" AND B1:B10 > 10
+ *
+ * Note:
+ * - All criteria must be satisfied for a value to be included
+ * - Only numeric values are considered for the maximum
+ * - Returns error if no values match all criteria
+ */
+export declare const MAXIFS: FunctionDefinition;

package/dist/types/functions/math/max/maxifs.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/min/min-utils.d.ts

@@ -0,0 +1,20 @@
+import { type FunctionEvaluationResult, type SingleEvaluationResult, type CellInfinity } from "src/core/types";
+import type { EvaluationContext } from "src/evaluator/evaluation-context";
+/**
+ * Result type for processInfinity in min functions
+ */
+export type ProcessInfinityResult<T> = {
+    type: "infinity";
+    infinity: CellInfinity;
+} | {
+    type: "state";
+    state: T;
+};
+/**
+ * Perform minimum calculation over an iterator of SingleEvaluationResults
+ * Handles the common logic shared by MIN, MINIF, MINIFS functions
+ *
+ * @param results - Iterator of SingleEvaluationResults to find minimum from
+ * @returns FunctionEvaluationResult with the minimum, infinity, or error
+ */
+export declare function performMinimum(results: Iterable<SingleEvaluationResult>, context: EvaluationContext): FunctionEvaluationResult;

package/dist/types/functions/math/min/min.d.ts

@@ -0,0 +1,5 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * MIN function - Returns the smallest number in the arguments
+ */
+export declare const MIN: FunctionDefinition;

package/dist/types/functions/math/min/min.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/min/minif.d.ts

@@ -0,0 +1,23 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * MINIF function - Returns the minimum value among cells specified by a criteria
+ *
+ * Usage: MINIF(range, criteria, [min_range])
+ *
+ * range: The range of cells to evaluate against the criteria
+ * criteria: The criteria to match against. Can be:
+ *   - Exact value: "Apple", 42
+ *   - Comparison: ">10", "<=5", "<>0"
+ *   - Wildcards: "App*", "?ruit"
+ * min_range: Optional. The range to find minimum from. If omitted, uses the range parameter
+ *
+ * Examples:
+ *   MINIF(A1:A10, "Apple") - min of cells in A1:A10 that contain "Apple"
+ *   MINIF(B1:B10, ">10") - min of cells in B1:B10 with values greater than 10
+ *   MINIF(A1:A10, "Apple", B1:B10) - min of B1:B10 where A1:A10 contains "Apple"
+ *
+ * Note:
+ * - Only numeric values are considered for the minimum
+ * - Returns error if no values match the criteria
+ */
+export declare const MINIF: FunctionDefinition;

package/dist/types/functions/math/min/minif.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/min/minifs.d.ts

@@ -0,0 +1,21 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * MINIFS function - Returns the minimum value among cells specified by multiple criteria
+ *
+ * Usage: MINIFS(min_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)
+ *
+ * min_range: The range of cells from which you want the minimum
+ * criteria_range1: The first range in which to evaluate criteria
+ * criteria1: The criteria to apply to criteria_range1
+ * criteria_range2, criteria2: Optional additional criteria pairs
+ *
+ * Examples:
+ *   MINIFS(B1:B10, A1:A10, "Apple") - min of B1:B10 where A1:A10 = "Apple"
+ *   MINIFS(C1:C10, A1:A10, "Apple", B1:B10, ">10") - min of C1:C10 where A1:A10 = "Apple" AND B1:B10 > 10
+ *
+ * Note:
+ * - All criteria must be satisfied for a value to be included
+ * - Only numeric values are considered for the minimum
+ * - Returns error if no values match all criteria
+ */
+export declare const MINIFS: FunctionDefinition;

package/dist/types/functions/math/min/minifs.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/sum/sum.d.ts

@@ -0,0 +1,5 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * SUM function - Adds all numbers in the arguments
+ */
+export declare const SUM: FunctionDefinition;

package/dist/types/functions/math/sum/sum.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/sum/sumif.d.ts

@@ -0,0 +1,23 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * SUMIF function - Sums cells in a range that meet a criteria
+ *
+ * Usage: SUMIF(range, criteria, [sum_range])
+ *
+ * range: The range of cells to evaluate against the criteria
+ * criteria: The criteria to match against. Can be:
+ *   - Exact value: "Apple", 42
+ *   - Comparison: ">10", "<=5", "<>0"
+ *   - Wildcards: "App*", "?ruit"
+ * sum_range: Optional. The range to sum. If omitted, uses the range parameter
+ *
+ * Examples:
+ *   SUMIF(A1:A10, "Apple") - sums cells in A1:A10 that contain "Apple"
+ *   SUMIF(B1:B10, ">10") - sums cells in B1:B10 with values greater than 10
+ *   SUMIF(A1:A10, "Apple", B1:B10) - sums B1:B10 where A1:A10 contains "Apple"
+ *
+ * Note:
+ * - Only numeric values are included in the sum
+ * - Returns 0 if no values match the criteria
+ */
+export declare const SUMIF: FunctionDefinition;

package/dist/types/functions/math/sum/sumif.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/sum/sumifs.d.ts

@@ -0,0 +1,21 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * SUMIFS function - Sums cells in a range that meet multiple criteria
+ *
+ * Usage: SUMIFS(sum_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)
+ *
+ * sum_range: The range of cells to sum
+ * criteria_range1: The first range to evaluate against criteria1
+ * criteria1: The first criteria to match against
+ * criteria_range2, criteria2: Optional additional criteria pairs
+ *
+ * Examples:
+ *   SUMIFS(B1:B10, A1:A10, "Apple") - sums B1:B10 where A1:A10 = "Apple"
+ *   SUMIFS(C1:C10, A1:A10, "Apple", B1:B10, ">10") - sums C1:C10 where A1:A10 = "Apple" AND B1:B10 > 10
+ *
+ * Note:
+ * - All criteria must be satisfied for a value to be included
+ * - Only numeric values are included in the sum
+ * - Returns 0 if no values match all criteria (unlike other IFS functions that return error)
+ */
+export declare const SUMIFS: FunctionDefinition;

package/dist/types/functions/math/sum/sumifs.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/math/sum/summation-utils.d.ts

@@ -0,0 +1,19 @@
+import { type FunctionEvaluationResult, type SingleEvaluationResult, type CellInfinity } from "src/core/types";
+/**
+ * Result type for processInfinity in sum functions
+ */
+export type ProcessInfinityResult<T> = {
+    type: "infinity";
+    infinity: CellInfinity;
+} | {
+    type: "state";
+    state: T;
+};
+/**
+ * Perform summation with error propagation
+ * Used when errors should be propagated instead of skipped (e.g., SUM with direct error arguments)
+ *
+ * @param results - Iterator of SingleEvaluationResults to sum
+ * @returns FunctionEvaluationResult with the sum, infinity, or first error encountered
+ */
+export declare function performSummation(results: Iterable<SingleEvaluationResult>): FunctionEvaluationResult;

package/dist/types/functions/reference/address/address.d.ts

@@ -0,0 +1,18 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * ADDRESS function - Creates a cell reference as text given row and column numbers
+ *
+ * Usage: ADDRESS(row_num, column_num, [abs_num], [a1], [sheet_text])
+ *
+ * row_num: The row number to use in the cell reference
+ * column_num: The column number to use in the cell reference
+ * abs_num: (optional) Type of reference to return (1=absolute, 2=absolute row/relative col, 3=relative row/absolute col, 4=relative)
+ * a1: (optional) A logical value that specifies the A1 or R1C1 reference style (TRUE or omitted = A1 style)
+ * sheet_text: (optional) The name of the worksheet to be used as the external reference
+ *
+ * Examples:
+ * - ADDRESS(2, 3) returns "$C$2"
+ * - ADDRESS(2, 3, 4) returns "C2"
+ * - ADDRESS(2, 3, 1, TRUE, "Sheet2") returns "Sheet2!$C$2"
+ */
+export declare const ADDRESS: FunctionDefinition;

package/dist/types/functions/reference/address/address.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/reference/indirect/indirect.d.ts

@@ -0,0 +1,20 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * INDIRECT function - Returns the reference specified by a text string
+ *
+ * Usage: INDIRECT(ref_text, [a1])
+ *
+ * ref_text: A reference to a cell that contains an A1-style reference, an R1C1-style reference,
+ *           a name defined as a reference, or a reference to a cell as a text string
+ * a1: (optional) A logical value that specifies what type of reference is in ref_text
+ *     TRUE or omitted = A1-style reference
+ *     FALSE = R1C1-style reference
+ *
+ * Examples:
+ * - INDIRECT("A1") returns the value in cell A1
+ * - INDIRECT("B" & ROW()) returns the value in column B of the current row
+ * - INDIRECT("Sheet2!A1") returns the value in cell A1 of Sheet2
+ *
+ * Note: This function is volatile - it recalculates whenever the worksheet recalculates
+ */
+export declare const INDIRECT: FunctionDefinition;

package/dist/types/functions/reference/indirect/indirect.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/reference/offset/offset.d.ts

@@ -0,0 +1,23 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * OFFSET function - Returns a reference offset from a given reference
+ *
+ * Usage: OFFSET(reference, rows, cols, [height], [width])
+ *
+ * reference: The reference from which you want to base the offset
+ * rows: The number of rows, up or down, that you want the upper-left cell to refer to
+ * cols: The number of columns, left or right, that you want the upper-left cell to refer to
+ * height: (optional) The height, in number of rows, that you want the returned reference to be
+ * width: (optional) The width, in number of columns, that you want the returned reference to be
+ *
+ * Examples:
+ * - OFFSET(A1, 2, 3) returns the value in cell D3 (2 rows down, 3 columns right from A1)
+ * - OFFSET(A1, 0, 0, 3, 1) returns the range A1:A3
+ * - OFFSET(A1, 1, 1, 2, 2) returns the range B2:C3
+ *
+ * Notes:
+ * - If rows or cols offset reference from the edge of the worksheet, returns #REF! error
+ * - Height and width must be positive
+ * - If height or width is omitted, the same height or width as reference is used
+ */
+export declare const OFFSET: FunctionDefinition;

package/dist/types/functions/reference/offset/offset.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/text/concatenate/concatenate.d.ts

@@ -0,0 +1,5 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * CONCATENATE function implementation
+ */
+export declare const CONCATENATE: FunctionDefinition;

package/dist/types/functions/text/concatenate/concatenate.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/text/exact/exact.d.ts

@@ -0,0 +1,5 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * EXACT function implementation
+ */
+export declare const EXACT: FunctionDefinition;

package/dist/types/functions/text/exact/exact.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/text/find/find.d.ts

@@ -0,0 +1,20 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * FIND function - Finds one text string within another (case-sensitive)
+ *
+ * Usage: FIND(find_text, within_text, [start_num])
+ *
+ * find_text: The text you want to find.
+ * within_text: The text containing the text you want to find.
+ * start_num: [Optional] The character at which to start the search (default: 1).
+ *
+ * Example: FIND("World", "Hello World", 1) returns 7
+ *
+ * Note:
+ * - The search is case-sensitive
+ * - Returns the position of the first character of find_text within within_text
+ * - Returns #VALUE! error if text is not found
+ * - Supports dynamic arrays (spilled values) for find_text and within_text
+ * - Strict type checking: text arguments must be strings, start_num must be number
+ */
+export declare const FIND: FunctionDefinition;

package/dist/types/functions/text/find/find.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/text/left/left.d.ts

@@ -0,0 +1,19 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * LEFT function - Returns the leftmost characters from a text string
+ *
+ * Usage: LEFT(text, num_chars)
+ *
+ * text: The text string to extract characters from.
+ * num_chars: The number of characters to extract from the left side of the text.
+ *
+ * Example: LEFT("Hello, World!", 5) returns "Hello"
+ *
+ * Note:
+ * - If num_chars is less than 0, the function returns an error.
+ * - If num_chars is greater than the length of text, the function returns the entire text.
+ * - Supports dynamic arrays (spilled values) for both arguments
+ * - Strict type checking: text must be string, num_chars must be number
+ * - Implemented as MID(text, 1, num_chars)
+ */
+export declare const LEFT: FunctionDefinition;

package/dist/types/functions/text/left/left.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/text/len/len.d.ts

@@ -0,0 +1,16 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * LEN function - Returns the length of a text string
+ *
+ * Usage: LEN(text)
+ *
+ * text: The text string whose length you want to find.
+ *
+ * Example: LEN("Hello World") returns 11
+ *
+ * Note:
+ * - Supports dynamic arrays (spilled values) for the text argument
+ * - Strict type checking: text must be string
+ * - Returns the number of characters in the text string
+ */
+export declare const LEN: FunctionDefinition;

package/dist/types/functions/text/len/len.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/text/mid/mid.d.ts

@@ -0,0 +1,20 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * MID function - Returns characters from the middle of a text string
+ *
+ * Usage: MID(text, start_num, num_chars)
+ *
+ * text: The text string to extract characters from.
+ * start_num: The position of the first character to extract (1-based).
+ * num_chars: The number of characters to extract.
+ *
+ * Example: MID("Hello, World!", 8, 5) returns "World"
+ *
+ * Note:
+ * - If start_num is less than 1, the function returns an error.
+ * - If num_chars is less than 0, the function returns an error.
+ * - If start_num is greater than the length of text, the function returns an empty string.
+ * - Supports dynamic arrays (spilled values) for all arguments
+ * - Strict type checking: text must be string, start_num and num_chars must be numbers
+ */
+export declare const MID: FunctionDefinition;

package/dist/types/functions/text/mid/mid.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/text/right/right.d.ts

@@ -0,0 +1,2 @@
+import { type FunctionDefinition } from "src/core/types";
+export declare const RIGHT: FunctionDefinition;

package/dist/types/functions/text/right/right.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/functions/text/text-helpers.d.ts

@@ -0,0 +1,27 @@
+import { type CellString, type FunctionEvaluationResult, type ErrorEvaluationResult } from "src/core/types";
+import type { FormulaEvaluator } from "src/evaluator/formula-evaluator";
+import type { EvaluationContext } from "src/evaluator/evaluation-context";
+/**
+ * Strictly extracts string value without type coercion
+ */
+export declare function convertToString(result: FunctionEvaluationResult, context: EvaluationContext): string | ErrorEvaluationResult;
+/**
+ * Strictly extracts numeric value without type coercion
+ */
+export declare function extractNumericValue(result: FunctionEvaluationResult, context: EvaluationContext): number | ErrorEvaluationResult;
+/**
+ * MID substring operation for MID function
+ */
+export declare function midOperation(textResult: FunctionEvaluationResult, startNumResult: FunctionEvaluationResult, numCharsResult: FunctionEvaluationResult, context: EvaluationContext): {
+    type: "value";
+    result: CellString;
+} | ErrorEvaluationResult;
+/**
+ * Helper for creating spilled-values result for MID function (3 parameters)
+ */
+export declare function createMidSpilledResult(this: FormulaEvaluator, { textResult, startNumResult, numCharsResult, context, }: {
+    textResult: FunctionEvaluationResult;
+    startNumResult: FunctionEvaluationResult;
+    numCharsResult: FunctionEvaluationResult;
+    context: EvaluationContext;
+}): FunctionEvaluationResult;

package/dist/types/functions/text/textjoin/textjoin.d.ts

@@ -0,0 +1,5 @@
+import { type FunctionDefinition } from "src/core/types";
+/**
+ * TEXTJOIN function implementation
+ */
+export declare const TEXTJOIN: FunctionDefinition;

package/dist/types/functions/text/textjoin/textjoin.test.d.ts

@@ -0,0 +1 @@
+export {};