@odoo/o-spreadsheet 19.2.12 → 19.3.3

package/dist/types/formulas/code_builder.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Block of code that produces a value.
+ */
+export interface FunctionCode {
+    readonly returnExpression: string;
+    /**
+     * Return the same function code but with the return expression assigned to a variable.
+     */
+    assignResultToVariable(): FunctionCode;
+}
+export declare class FunctionCodeBuilder {
+    private scope;
+    private code;
+    constructor(scope?: Scope);
+    append(...lines: (string | FunctionCode)[]): void;
+    return(expression: string): FunctionCode;
+    toString(): string;
+}
+export declare class Scope {
+    private nextId;
+    private declaredVariables;
+    nextVariableName(): string;
+    isAlreadyDeclared(name: string): boolean;
+}

package/dist/types/formulas/compiler.d.ts

@@ -0,0 +1,108 @@
+import { CoreGetters } from "../types/core_getters";
+import { ApplyRangeChange, ApplyRenameNamedRange, FormulaToExecute, LiteralValues, NamedRange, UID } from "../types/misc";
+import { Range, RangeStringOptions } from "../types/range";
+import { AST } from "./parser";
+import { Token } from "./tokenizer";
+export declare const OPERATOR_MAP: {
+    "=": string;
+    "+": string;
+    "-": string;
+    "*": string;
+    "/": string;
+    ">=": string;
+    "<>": string;
+    ">": string;
+    "<=": string;
+    "<": string;
+    "^": string;
+    "&": string;
+};
+export declare const UNARY_OPERATOR_MAP: {
+    "-": string;
+    "+": string;
+    "%": string;
+    "#": string;
+};
+interface ICompiledFormula {
+    execute: FormulaToExecute;
+    tokens: Token[];
+    dependencies: string[];
+    isBadExpression: boolean;
+    normalizedFormula: string;
+    literalValues: LiteralValues;
+    symbols: string[];
+}
+export declare const functionCache: {
+    [key: string]: FormulaToExecute;
+};
+/**
+ * A compiled formula is the result of the compilation of a formula string.
+ * It contains all the information needed to execute the formula, as well as some metadata
+ * about the formula (dependencies, literal values, symbols...) that can be used to rebuild a slightly different formula
+ * without recompiling it (for example when the formula is copied to another cell, or when we want to replace literal values but keep the same structure).
+ * */
+export declare class CompiledFormula implements Omit<ICompiledFormula, "tokens" | "dependencies"> {
+    readonly sheetId: UID;
+    private readonly tokens;
+    readonly literalValues: LiteralValues;
+    readonly symbols: string[];
+    readonly isBadExpression: boolean;
+    readonly normalizedFormula: string;
+    readonly execute: FormulaToExecute;
+    readonly rangeDependencies: Range[];
+    hasDependencies: boolean;
+    private constructor();
+    private getTokens;
+    getAst(getters: CoreGetters): AST;
+    /**
+     * Return the string representation of the formula, with the current dependencies and literal values.
+     * This is a heavy operation as it converts the rangeDependencies to string on each call.
+     * */
+    toFormulaString(getters: CoreGetters, referenceOption?: RangeStringOptions): string;
+    getNamedRangesInFormula(getters: CoreGetters): NamedRange[];
+    usesSymbol(symbol: string): boolean;
+    areAllFunctionsExportableToExcel(): boolean;
+    getFunctionsFromTokens(functionNames: string[], getters: CoreGetters): {
+        functionName: string;
+        args: AST[];
+    }[];
+    isFirstNonWhitespaceSymbol(tokenValue: string): boolean;
+    adaptCompiledFormula(applyChange: ApplyRangeChange, applyUpdateNamedRange: ApplyRenameNamedRange): CompiledFormula;
+    /** Change the symbols and tokens on a named range change. Return undefined if nothing has changed. */
+    private renameNamedRangeTokens;
+    static IsBadExpression(formula: string): boolean;
+    /**
+     * Recreates a CompiledFormula based on `base` with adapted dependencies.
+     * */
+    static CopyWithDependencies(base: CompiledFormula, sheetId: UID, dependencies: Range[]): CompiledFormula;
+    /**
+     * Recreates a CompiledFormula based on `base` with adapted dependencies and/or different literal values.
+     * */
+    static CopyWithDependenciesAndLiteral(base: CompiledFormula, sheetId: UID, dependencies: Range[], literalNumbers: {
+        value: number;
+    }[], literalStrings: {
+        value: string;
+    }[]): CompiledFormula;
+    /**
+     * When copy/pasting a formula across sheets, the formula is serialized (all it's serializable properties are kept) and deserialized on the new sheet.
+     * This function allows to recompile the formula based on the serializable properties.
+     * */
+    static CompileForSerializedFormula(sheetId: UID, base: SerializedCompiledFormula): CompiledFormula;
+    /**
+     * Make a new instance of CompiledFormula by compiling the formula string as input by the user.
+     * */
+    static Compile(formula: string, sheetId: UID, getters: CoreGetters): CompiledFormula;
+}
+/**
+ * A compiled formula serialized
+ * */
+export type SerializedCompiledFormula = {
+    sheetId: UID;
+    tokens: Token[];
+    literalValues: LiteralValues;
+    symbols: string[];
+    rangeDependencies: Range[];
+    isBadExpression: boolean;
+    normalizedFormula: string;
+};
+export {};

package/dist/types/formulas/composer_tokenizer.d.ts

@@ -0,0 +1,54 @@
+import { Locale } from "../types/locale";
+import { Color } from "../types/misc";
+import { AST } from "./parser";
+import { Token } from "./tokenizer";
+interface FunctionContext {
+    /**
+     * The parent function name of the token.
+     */
+    parent: string;
+    /**
+     * The position of the token within the argument list of its parent function.
+     */
+    argPosition: number;
+    /**
+     * An array of parsed arguments, possibly containing undefined values if the argument
+     * is empty or is an invalid expression.
+     */
+    args: (AST | undefined)[];
+    /**
+     * Array of token arrays representing the tokens for each argument.
+     * Needed as an intermediate step to parse the arguments AST (see `args` property).
+     */
+    argsTokens?: Token[][];
+}
+/**
+ * Enriched Token is used by the composer to add information on the tokens that
+ * are only needed during the edition of a formula.
+ *
+ * The information added are:
+ * - start, end and length of each token
+ * - parenthesesCode (a code indicating the position of the token in the parentheses tree)
+ * - functionContext (only for tokens surrounded by a function)
+ * - color (the base color of the token, without fading modification)
+ * - isBlurred (indicates whether the text should be highlighted or not, useful to know if the token matches the same formula as the cursor token)
+ * - isParenthesisLinkedToCursor (Useful for highlighting tokens related to the current token, such as matching parentheses)
+ */
+export interface EnrichedToken extends Token {
+    start: number;
+    end: number;
+    length: number;
+    parenthesesCode?: string;
+    functionContext?: FunctionContext;
+    color?: Color;
+    isBlurred?: boolean;
+    isParenthesisLinkedToCursor?: boolean;
+    isInHoverContext?: boolean;
+}
+/**
+ * Take the result of the tokenizer and transform it to be usable in the composer.
+ *
+ * @param formula
+ */
+export declare function composerTokenize(formula: string, locale: Locale): EnrichedToken[];
+export {};

package/dist/types/formulas/formula_formatter.d.ts

@@ -0,0 +1,18 @@
+import { AST } from "./parser";
+/**
+ * Pretty-prints formula ASTs into readable formulas.
+ *
+ * Implements a Wadler-inspired pretty printer:
+ * it converts an AST into a `Doc` structure,
+ * and then chooses between compact (flat) or expanded (with
+ * line breaks and indentation) layouts depending on space.
+ *
+ * References:
+ * - https://lik.ai/blog/how-a-pretty-printer-works/
+ * - Wadler, "A prettier printer": https://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf
+ */
+export declare function prettify(ast: AST, width?: number): string;
+/**
+ * Converts an ast formula to the corresponding string
+ */
+export declare function astToFormula(ast: AST): string;

package/dist/types/formulas/parser.d.ts

@@ -0,0 +1,107 @@
+import { Token } from "./tokenizer";
+interface RichToken extends Token {
+    tokenIndex: number;
+}
+export declare class TokenList {
+    private tokens;
+    currentIndex: number;
+    current: RichToken | undefined;
+    length: number;
+    constructor(tokens: RichToken[]);
+    shift(): RichToken;
+    get next(): RichToken | undefined;
+}
+interface ASTBase {
+    debug?: boolean;
+    tokenStartIndex: number;
+    tokenEndIndex: number;
+}
+interface ASTNumber extends ASTBase {
+    type: "NUMBER";
+    value: number;
+}
+interface ASTReference extends ASTBase {
+    type: "REFERENCE";
+    value: string;
+}
+export interface ASTString extends ASTBase {
+    type: "STRING";
+    value: string;
+}
+interface ASTBoolean extends ASTBase {
+    type: "BOOLEAN";
+    value: boolean;
+}
+export interface ASTUnaryOperation extends ASTBase {
+    type: "UNARY_OPERATION";
+    value: any;
+    operand: AST;
+    postfix?: boolean;
+}
+export interface ASTOperation extends ASTBase {
+    type: "BIN_OPERATION";
+    value: any;
+    left: AST;
+    right: AST;
+}
+export interface ASTFuncall extends ASTBase {
+    type: "FUNCALL";
+    value: string;
+    args: AST[];
+}
+export interface ASTSymbol extends ASTBase {
+    type: "SYMBOL";
+    value: string;
+}
+export interface ASTArray extends ASTBase {
+    type: "ARRAY";
+    value: AST[][];
+}
+interface ASTEmpty extends ASTBase {
+    type: "EMPTY";
+    value: "";
+}
+export type AST = ASTOperation | ASTUnaryOperation | ASTFuncall | ASTSymbol | ASTArray | ASTNumber | ASTBoolean | ASTString | ASTReference | ASTEmpty;
+export declare const OP_PRIORITY: {
+    "#": number;
+    "%": number;
+    "^": number;
+    "*": number;
+    "/": number;
+    "+": number;
+    "-": number;
+    "&": number;
+    ">": number;
+    "<>": number;
+    ">=": number;
+    "<": number;
+    "<=": number;
+    "=": number;
+};
+/**
+ * Parse an expression (as a string) into an AST.
+ */
+export declare function parse(str: string): AST;
+export declare function parseTokens(tokens: readonly Token[]): AST;
+/**
+ * Allows to visit all nodes of an AST and apply a mapping function
+ * to nodes of a specific type.
+ * Useful if you want to convert some part of a formula.
+ *
+ * @example
+ * convertAstNodes(ast, "FUNCALL", convertFormulaToExcel)
+ *
+ * function convertFormulaToExcel(ast: ASTFuncall) {
+ *   // ...
+ *   return modifiedAst
+ * }
+ */
+export declare function convertAstNodes<T extends AST["type"]>(ast: AST, type: T, fn: (ast: Extract<AST, {
+    type: T;
+}>) => AST): AST;
+export declare function iterateAstNodes(ast: AST): AST[];
+export declare function mapAst<T extends AST["type"]>(ast: AST, fn: (ast: Extract<AST, {
+    type: T;
+}>) => AST): AST;
+export declare function isFuncallToken(currentToken: Token, nextToken: Token | undefined): boolean;
+export {};

package/dist/types/formulas/range_tokenizer.d.ts

@@ -0,0 +1,8 @@
+import { Token } from "./tokenizer";
+/**
+ * Take the result of the tokenizer and transform it to be usable in the
+ * manipulations of range
+ *
+ * @param formula
+ */
+export declare function rangeTokenize(formula: string, locale?: import("..").Locale): Token[];

package/dist/types/formulas/tokenizer.d.ts

@@ -0,0 +1,26 @@
+import { type Locale } from "../types/locale";
+/**
+ * Tokenizer
+ *
+ * A tokenizer is a piece of code whose job is to transform a string into a list
+ * of "tokens". For example, "(12+" is converted into:
+ *   [{type: "LEFT_PAREN", value: "("},
+ *    {type: "NUMBER", value: "12"},
+ *    {type: "OPERATOR", value: "+"}]
+ *
+ * As the example shows, a tokenizer does not care about the meaning behind those
+ * tokens. It only cares about the structure.
+ *
+ * The tokenizer is usually the first step in a compilation pipeline.  Also, it
+ * is useful for the composer, which needs to be able to work with incomplete
+ * formulas.
+ */
+export declare const POSTFIX_UNARY_OPERATORS: string[];
+export declare const DEBUGGER_CHAR = "?";
+type TokenType = "OPERATOR" | "NUMBER" | "STRING" | "SYMBOL" | "SPACE" | "DEBUGGER" | "ARG_SEPARATOR" | "ARRAY_ROW_SEPARATOR" | "LEFT_PAREN" | "RIGHT_PAREN" | "LEFT_BRACE" | "RIGHT_BRACE" | "REFERENCE" | "INVALID_REFERENCE" | "UNKNOWN";
+export interface Token {
+    readonly type: TokenType;
+    value: string;
+}
+export declare function tokenize(str: string, locale?: Locale): Token[];
+export {};

package/dist/types/functions/arguments.d.ts

@@ -0,0 +1,90 @@
+import { Immutable } from "../types";
+import { AddFunctionDescription, ArgDefinition, ArgProposal, FunctionDescription } from "../types/functions";
+export declare function arg(definition: string, description?: string, proposals?: ArgProposal[]): ArgDefinition;
+/**
+ * This function adds on description more general information derived from the
+ * arguments.
+ *
+ * This information is useful during compilation.
+ */
+export declare function addMetaInfoFromArg(name: string, addDescr: AddFunctionDescription): FunctionDescription;
+type ArgToFocus = Immutable<Record<number, {
+    index: number;
+    repeatingGroupIndex?: number;
+}>>;
+/**
+ * Returns a function that maps the position of a value in a function to its corresponding argument index.
+ *
+ * In most cases, the task is straightforward:
+ *
+ * In the formula "=SUM(11, 55, 66)" which is defined like this "SUM(value1, [value2, ...])":
+ * - 11 corresponds to the value1 argument => position will be 0
+ * - 55 and 66 correspond to the [value2, ...] argument => position will be 1
+ *
+ * In other cases, optional arguments could be defined after repeatable arguments,
+ * or even optional and required arguments could be mixed in unconventional ways.
+ *
+ * The next function has been designed to handle all possible configurations.
+ * The only restriction is if repeatable arguments are present in the function definition:
+ * - they must be defined consecutively
+ * - they must be in a quantity greater than the optional arguments.
+ *
+ * The markdown tables below illustrate how values are mapped to positions based on the number of values supplied.
+ * Each table represents a different function configuration, with columns representing the number of values supplied as arguments
+ * and rows representing the correspondence with the argument index.
+ *
+ * The tables are built based on the following conventions:
+ * - `m`: Mandatory argument (count as one argument)
+ * - `o`: Optional argument (count as zero or one argument)
+ * - `r`: Repeating argument (count as one or more arguments)
+ *
+ *
+ * Configuration 1: (m, o) like the CEILING function
+ *
+ * |   | 1 | 2 |
+ * |---|---|---|
+ * | m | 0 | 0 |
+ * | o |   | 1 |
+ *
+ *
+ * Configuration 2: (m, m, m, r, r) like the SUMIFS function
+ *
+ * |   | 5 | 7    | 3 + 2n     |
+ * |---|---|------|------------|
+ * | m | 0 | 0    | 0          |
+ * | m | 1 | 1    | 1          |
+ * | m | 2 | 2    | 2          |
+ * | r | 3 | 3, 5 | 3 + 2n     |
+ * | r | 4 | 4, 6 | 3 + 2n + 1 |
+ *
+ *
+ * Configuration 3: (m, m, m, r, r, o) like the SWITCH function
+ *
+ * |   | 5 | 6 | 7    | 8    | 3 + 2n     | 3 + 2n + 1     |
+ * |---|---|---|------|------|------------|----------------|
+ * | m | 0 | 0 | 0    | 0    | 0          | 0              |
+ * | m | 1 | 1 | 1    | 1    | 1          | 1              |
+ * | m | 2 | 2 | 2    | 2    | 2          | 2              |
+ * | r | 3 | 3 | 3, 5 | 3, 5 | 3 + 2n     | 3 + 2n         |
+ * | r | 4 | 4 | 4, 6 | 4, 6 | 3 + 2n + 1 | 3 + 2n + 1     |
+ * | o |   | 5 |      | 7    |            | 3 + 2N + 2     |
+ *
+ *
+ * Configuration 4: (m, o, m, o, r, r, r, m) a complex case to understand subtleties
+ *
+ * |   | 6 | 7 | 8 | 9    | 10   | 11   | ... |
+ * |---|---|---|---|------|------|------|-----|
+ * | m | 0 | 0 | 0 | 0    | 0    | 0    | ... |
+ * | o |   | 1 | 1 |      | 1    | 1    | ... |
+ * | m | 1 | 2 | 2 | 1    | 2    | 2    | ... |
+ * | o |   |   | 3 |      |      | 3    | ... |
+ * | r | 2 | 3 | 4 | 2, 5 | 3, 6 | 4, 7 | ... |
+ * | r | 3 | 4 | 5 | 3, 6 | 4, 7 | 5, 8 | ... |
+ * | r | 4 | 5 | 6 | 4, 7 | 5, 8 | 6, 9 | ... |
+ * | m | 5 | 6 | 7 | 8    | 9    | 10   | ... |
+ *
+ */
+export declare function argTargeting(functionDescription: FunctionDescription, nbrArgSupplied: number): ArgToFocus;
+export declare function _argTargeting(functionDescription: FunctionDescription, nbrArgSupplied: number): ArgToFocus;
+export declare function validateArguments(descr: FunctionDescription): void;
+export {};

package/dist/types/functions/autocomplete_arguments_provider.d.ts

@@ -0,0 +1,13 @@
+import { CellComposerStore } from "../components/composer/composer/cell_composer_store";
+import { EnrichedToken } from "../formulas/composer_tokenizer";
+import { AutoCompleteProposal } from "../registries/auto_completes/auto_complete_registry";
+import { ArgDefinition } from "../types";
+export declare function createAutocompleteArgumentsProvider(formulaName: string, args: ArgDefinition[]): void;
+/**
+ * Perform the autocomplete of the composer by inserting the value
+ * at the cursor position, replacing the current token if necessary.
+ * Must be bound to the autocomplete provider.
+ */
+export declare function insertTokenAtArgStartingPosition(this: {
+    composer: CellComposerStore;
+}, tokenAtCursor: EnrichedToken, proposal: AutoCompleteProposal): void;

package/dist/types/functions/create_compute_function.d.ts

@@ -0,0 +1,5 @@
+import { ComputeFunction, FunctionDescription } from "../types/functions";
+import { FunctionResultObject, Matrix } from "../types/misc";
+export declare function createComputeFunction(descr: FunctionDescription): ComputeFunction<Matrix<FunctionResultObject> | FunctionResultObject>;
+export declare function handleError(e: unknown, functionName: string): FunctionResultObject;
+export declare const implementationErrorMessage: string;

package/dist/types/functions/function_registry.d.ts

@@ -0,0 +1,11 @@
+import { Registry } from "../registry";
+import { AddFunctionDescription, ComputeFunction, FunctionDescription } from "../types/functions";
+import { FunctionResultObject, Matrix } from "../types/misc";
+export declare class FunctionRegistry extends Registry<FunctionDescription> {
+    mapping: {
+        [key: string]: ComputeFunction<Matrix<FunctionResultObject> | FunctionResultObject>;
+    };
+    add(name: string, addDescr: AddFunctionDescription): this;
+    replace(name: string, addDescr: AddFunctionDescription): this;
+}
+export declare const functionRegistry: FunctionRegistry;

package/dist/types/functions/function_registry_population.d.ts

@@ -0,0 +1,10 @@
+import { AddFunctionDescription } from "../types/functions";
+type Functions = {
+    [functionName: string]: AddFunctionDescription;
+};
+type Category = {
+    name: string;
+    functions: Functions;
+};
+export declare const categories: Category[];
+export {};

package/dist/types/functions/helper_assert.d.ts

@@ -0,0 +1,8 @@
+import { Arg, FunctionResultNumber, FunctionResultObject, Matrix } from "../types/misc";
+export declare function assert(condition: boolean, message: string): asserts condition;
+export declare function assertNotZero(value: number, message?: string): void;
+export declare function isSingleColOrRow(arg: Matrix): boolean;
+export declare function areSameDimensions(...args: Arg[]): boolean;
+export declare function isSquareMatrix(arg: Matrix): boolean;
+export declare function isNumberMatrix(arg: Matrix<FunctionResultObject>): arg is Matrix<FunctionResultNumber>;
+export declare const expectNumberGreaterThanOrEqualToOne: (value: number) => string;

package/dist/types/functions/helper_financial.d.ts

@@ -0,0 +1,59 @@
+import { Locale } from "../types/locale";
+export declare const expectCashFlowsAndDatesHaveSameDimension: string;
+export declare const expectCashFlowsHavePositiveAndNegativesValues: string;
+export declare const expectCostPositiveOrZero: (cost: number) => string;
+export declare const expectCostStrictlyPositive: (cost: number) => string;
+export declare const expectCouponFrequencyIsValid: (frequency: number) => string;
+export declare const expectDayCountConventionIsValid: (dayCountConvention: number) => string;
+export declare const expectDeprecationFactorStrictlyPositive: (factor: number) => string;
+export declare const expectDiscountDifferentFromMinusOne: (discount: number) => string;
+export declare const expectDiscountStrictlyPositive: (discount: number) => string;
+export declare const expectDiscountStrictlySmallerThanOne: (discount: number) => string;
+export declare const expectEffectiveRateStrictlyPositive: (effectiveRate: number) => string;
+export declare const expectEndPeriodPositiveOrZero: (endPeriod: number) => string;
+export declare const expectEndPeriodSmallerOrEqualToLife: (end: number, life: number) => string;
+export declare const expectEveryDateGreaterThanFirstDateOfCashFlowDates: (firstDate: number) => string;
+export declare const expectFirstPeriodSmallerOrEqualLastPeriod: (first: number, last: number) => string;
+export declare const expectFirstPeriodStrictlyPositive: (period: number) => string;
+export declare const expectFutureValueStrictlyPositive: (pv: number) => string;
+export declare const expectInvestmentStrictlyPositive: (investment: number) => string;
+export declare const expectIssuePositiveOrZero: (issue: number) => string;
+export declare const expectLastPeriodSmallerOrEqualNumberOfPeriods: (last: number, nPeriods: number) => string;
+export declare const expectLastPeriodStrictlyPositive: (period: number) => string;
+export declare const expectLifeStrictlyPositive: (life: number) => string;
+export declare const expectMaturityStrictlyGreaterThanSettlement: (settlement: number, maturity: number) => string;
+export declare const expectMonthBetweenOneAndTwelve: (month: number) => string;
+export declare const expectNominalRateStrictlyPositive: (nominalRate: number) => string;
+export declare const expectNumberOfPeriodDifferentFromZero: (nPeriods: number) => string;
+export declare const expectNumberOfPeriodsStrictlyPositive: (nPeriods: number) => string;
+export declare const expectPeriodBetweenOneAndNumberOfPeriods: (nPeriods: number) => string;
+export declare const expectPeriodLessOrEqualToLifeLimit: (period: number, lifeLimit: number) => string;
+export declare const expectPeriodPositiveOrZero: (period: number) => string;
+export declare const expectPeriodsByYearStrictlyPositive: (periodsByYear: number) => string;
+export declare const expectPeriodSmallerOrEqualToLife: (period: number, life: number) => string;
+export declare const expectPeriodStrictlyPositive: (period: number) => string;
+export declare const expectPresentValueStrictlyPositive: (pv: number) => string;
+export declare const expectPriceStrictlyPositive: (price: number) => string;
+export declare const expectPurchaseDateBeforeFirstPeriodEnd: (purchaseDate: number, firstPeriodEnd: number) => string;
+export declare const expectPurchaseDatePositiveOrZero: (purchaseDate: number) => string;
+export declare const expectRateGuessStrictlyGreaterThanMinusOne: (guess: number) => string;
+export declare const expectRatePositiveOrZero: (rate: number) => string;
+export declare const expectRateStrictlyPositive: (rate: number) => string;
+export declare const expectRedemptionStrictlyPositive: (redemption: number) => string;
+export declare const expectSalvagePositiveOrZero: (salvage: number) => string;
+export declare const expectSalvageSmallerOrEqualThanCost: (salvage: number, cost: number) => string;
+export declare const expectSettlementGreaterOrEqualToIssue: (settlement: number, issue: number) => string;
+export declare const expectSettlementLessThanOneYearBeforeMaturity: (settlement: number, maturity: number) => string;
+export declare const expectSettlementStrictlyGreaterThanIssue: (settlement: number, issue: number) => string;
+export declare const expectStartPeriodPositiveOrZero: (startPeriod: number) => string;
+export declare const expectStartPeriodSmallerOrEqualEndPeriod: (start: number, end: number) => string;
+export declare const expectUnitStrictlyPositive: (unit: number) => string;
+export declare const expectYieldPositiveOrZero: (yeld: number) => string;
+export declare function havePositiveAndNegativeValues(arrayNumbers: number[]): boolean;
+export declare function isInvalidDayCountConvention(dayCountConvention: number): boolean;
+export declare function isInvalidFrequency(frequency: number): boolean;
+export declare function isSettlementLessThanOneYearBeforeMaturity(settlement: number, maturity: number, locale: Locale): boolean;
+export declare const DAY_COUNT_CONVENTION_OPTIONS: {
+    value: number;
+    label: string;
+}[];

package/dist/types/functions/helper_logical.d.ts

@@ -0,0 +1,9 @@
+import { Arg } from "../types/misc";
+export declare function boolAnd(args: Arg[]): {
+    foundBoolean: boolean;
+    result: boolean;
+};
+export declare function boolOr(args: Arg[]): {
+    foundBoolean: boolean;
+    result: boolean;
+};

package/dist/types/functions/helper_lookup.d.ts

@@ -0,0 +1,11 @@
+import { CoreGetters } from "../types/core_getters";
+import { EvalContext } from "../types/functions";
+import { FunctionResultObject, Maybe, UID } from "../types/misc";
+import { PivotCoreMeasure } from "../types/pivot";
+/**
+ * Get the pivot ID from the formula pivot ID.
+ */
+export declare function getPivotId(pivotFormulaId: string, getters: CoreGetters): UID;
+export declare function assertMeasureExist(pivotId: UID, measure: string, getters: CoreGetters): void;
+export declare function assertDomainLength(domain: Maybe<FunctionResultObject>[]): void;
+export declare function addPivotDependencies(evalContext: EvalContext, pivotId: UID, forMeasures: PivotCoreMeasure[]): void;

package/dist/types/functions/helper_math.d.ts

@@ -0,0 +1,4 @@
+import { Locale } from "../types/locale";
+import { Arg } from "../types/misc";
+export declare function sum(values: Arg[], locale: Locale): number;
+export declare function countUnique(args: Arg[]): number;

package/dist/types/functions/helper_matrices.d.ts

@@ -0,0 +1,24 @@
+import { Matrix } from "../types/misc";
+export declare function getUnitMatrix(n: number): Matrix<number>;
+/**
+ * Invert a matrix and compute its determinant using Gaussian Elimination.
+ *
+ * The Matrix should be a square matrix, and should be indexed [col][row] instead of the
+ * standard mathematical indexing [row][col].
+ */
+export declare function invertMatrix(M: Matrix<number>): {
+    inverted?: Matrix<number>;
+    determinant: number;
+};
+/**
+ * Matrix multiplication of 2 matrices.
+ * ex: matrix1 : n x l, matrix2 : m x n => result : m x l
+ *
+ * Note: we use indexing [col][row] instead of the standard mathematical notation [row][col]
+ */
+export declare function multiplyMatrices(matrix1: Matrix<number>, matrix2: Matrix<number>): Matrix<number>;
+/**
+ * Return the input if it's a scalar or the first element of the input if it's a matrix.
+ */
+export declare function toScalar<T>(arg: Matrix<T> | T): T;
+export declare function isMultipleElementMatrix(arg: any): boolean;