@rowsncolumns/fast-formula-parser 6.2.32

package/index.d.ts

@@ -0,0 +1,234 @@
+declare module "@rowsncolumns/fast-formula-parser" {
+  export const MAX_ROW = 1048576;
+  export const MAX_COLUMN = 16384;
+
+  /** Set of all implemented function names for O(1) lookup */
+  export const implementedFunctionNames: Set<string>;
+  export type CellCoords = {
+    sheet?: string;
+    row: number;
+    col: number;
+    signal?: AbortSignal;
+    property?: string;
+  };
+
+  export type CellRange = {
+    sheet?: string;
+    from: Omit<CellCoords, "sheet">;
+    to: Omit<CellCoords, "sheet">;
+    signal?: AbortSignal;
+  };
+
+  export class FormulaError {
+    readonly error: string;
+    readonly message?: string;
+    readonly details?: string;
+    constructor(error: string, message?: string, details?: string);
+  }
+
+  function lex(text: string): LexResult;
+  function tolerantLex(text: string): LexResult;
+  const tokenVocabulary: Record<string, import("chevrotain").TokenType>;
+  const allTokens: import("chevrotain").TokenType[];
+  export type LexResult = {
+    tokens: Token[];
+    errors: TokenError[];
+    groups: Record<string, string>;
+  };
+  export type Token = {
+    image: string;
+    startOffset: number;
+    startColumn: number;
+    endOffset: number;
+    endColumn: number;
+    endLine: number;
+    tokenType: {
+      name: string;
+    };
+    tokenTypeIdx: number;
+  };
+  export type TokenError = {
+    line: number;
+    column: number;
+    message: string;
+  };
+  export { lex, tolerantLex, tokenVocabulary, allTokens };
+
+  export interface FormulaParserConfig {
+    functionsNeedContext?: Record<string, Function>;
+    onVariable?: (
+      name: string,
+      sheetName: string,
+      position: CellCoords,
+    ) => CellRange | CellCoords | undefined | FormulaResult;
+    onCell?: (
+      coords: CellCoords,
+    ) =>
+      | string
+      | number
+      | boolean
+      | Date
+      | null
+      | undefined
+      | FormulaError
+      | import("@rowsncolumns/common-types").StructuredResult;
+    onRange?: (
+      range: CellRange,
+    ) =>
+      | (
+          | string
+          | number
+          | boolean
+          | Date
+          | null
+          | undefined
+          | FormulaError
+          | import("@rowsncolumns/common-types").StructuredResult
+        )[][]
+      | undefined;
+    onStructuredReference?: (
+      tableName: string | undefined,
+      columnName: string[] | undefined,
+      thisRow: boolean,
+      specialItem: string | undefined,
+      sheetName: string,
+      coords: CellCoords,
+    ) => CellCoords | CellRange | undefined;
+    /**
+     * Resolve Excel's `A1#` spilled-range operator. Called when a cell
+     * ref is flagged `isSpilledRange`. Return the current spill bounds
+     * (`{from, to, sheet}`) of the dynamic-array formula anchored at
+     * the given coords, a `FormulaError` (`#REF!` / `#NAME?`) when no
+     * spill exists, or `undefined` to fall back to `#REF!`.
+     */
+    onSpilledRange?: (ref: {
+      col?: number;
+      row?: number;
+      sheet?: string;
+    }) => CellRange | FormulaError | undefined;
+    /**
+     * Report row visibility so SUBTOTAL can exclude hidden rows.
+     * Filtered-out rows are excluded for every function_number;
+     * manually-hidden rows only for 101-111.
+     */
+    onRowHidden?: (ref: {
+      sheet?: string;
+      row: number;
+    }) => { hiddenByFilter?: boolean; hiddenByUser?: boolean } | undefined;
+    webServiceProvider?: (
+      url: string,
+    ) =>
+      | string
+      | null
+      | undefined
+      | FormulaError
+      | Promise<string | null | undefined | FormulaError>;
+    fetch?: typeof fetch;
+    locale?: string;
+  }
+  export type FormulaResultArray = (string | number | boolean | Date)[][];
+
+  export type CompiledFormula = {
+    tokens: import("chevrotain").IToken[];
+    source?: string;
+  };
+
+  export type RecursiveFormula = {
+    _formulaResult: string;
+  };
+
+  export type FormulaResult =
+    | string
+    | number
+    | Date
+    | boolean
+    | undefined
+    | null
+    | FormulaResultArray
+    | import("@rowsncolumns/common-types").StructuredResult
+    | FormulaError
+    | RecursiveFormula
+    | import("@rowsncolumns/calculator").DataSource;
+
+  export default class FormulaParser<T extends unknown = any> {
+    constructor(config: FormulaParserConfig);
+    locale?: string;
+    parseAsync: (
+      text: string,
+      position: CellCoords,
+      returnArray?: boolean,
+    ) => Promise<FormulaResult | undefined | null>;
+    parse: (
+      text: string,
+      position: CellCoords,
+      returnArray?: boolean,
+    ) => FormulaResult;
+    parseCompiled: (
+      compiled: CompiledFormula,
+      position: CellCoords,
+      returnArray?: boolean,
+    ) => FormulaResult;
+    parseCompiledAsync: (
+      compiled: CompiledFormula,
+      position: CellCoords,
+      returnArray?: boolean,
+    ) => Promise<FormulaResult | undefined | null>;
+    compile(text: string): CompiledFormula;
+    static compileFormula(text: string): CompiledFormula;
+    position: CellCoords & { signal?: AbortSignal };
+    onRecalculation?(
+      position: CellCoords,
+      results: FormulaResult | null,
+      cleanup?: () => void,
+    ): void;
+    registerCleanupFunction(position: CellCoords, cleanup?: () => void);
+    markAsQueued?(position: CellCoords): void;
+    markAsLoading?(position: CellCoords): void;
+    markAsError?(position: CellCoords, value: string): void;
+    getSheetId(sheetName: string): number;
+    getSheetIndex?(sheetName?: string): number | undefined;
+    getSheetCount?(): number;
+    makeKey(position: import("@rowsncolumns/dag").CellCoordinate): string;
+    addArrayReference(
+      source: import("@rowsncolumns/dag").CellCoordinate,
+      result: FormulaResultArray,
+    ): void;
+    isPreview?: boolean;
+    getCellData(
+      position: CellCoords | CellRange,
+    ): T | undefined | null | (T | undefined | null)[];
+
+    /** Get a Set of all implemented function names for O(1) lookup */
+    static getImplementedFunctionNames(
+      config?: FormulaParserConfig,
+    ): Set<string>;
+  }
+
+  export interface DepParserConfig
+    extends Pick<FormulaParserConfig, "onVariable" | "onStructuredReference"> {}
+  export class DepParser {
+    constructor(config: DepParserConfig);
+    parse: (text: string, position: CellCoords) => CellCoords[] | CellRange[];
+  }
+
+  function accept(
+    value: string | number,
+    type: Types,
+    defValue?: string | number | undefined,
+    flat?: boolean,
+    allowSingleValue?: boolean,
+  ): string | number | boolean | {} | any[];
+  export const FormulaHelpers: {
+    accept: typeof accept;
+  };
+  export enum Types {
+    NUMBER = 0,
+    ARRAY = 1,
+    BOOLEAN = 2,
+    STRING = 3,
+    RANGE_REF = 4,
+    CELL_REF = 5,
+    COLLECTIONS = 6, // Unions of references
+    NUMBER_NO_BOOLEAN = 10,
+  }
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@rowsncolumns/fast-formula-parser",
+  "version": "6.2.32",
+  "description": "fast excel formula parser",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "typings": "index.d.ts",
+  "scripts": {
+    "test": "vitest --run",
+    "prepublishOnly": "yarn run build && yarn run test",
+    "build": "rollup --config rollup.config.mjs",
+    "build:watch": "rollup --watch --config rollup.config.mjs",
+    "diagram": "node grammar/diagram.js",
+    "docs": "yarn run diagram && jsdoc --configure .jsdoc.json --verbose",
+    "publish:docs": "yarn run docs && yarn run coverage && gh-pages -d docs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rowsncolumns/spreadsheet.git"
+  },
+  "bugs": {
+    "url": "https://github.com/rowsncolumns/spreadsheet/issues"
+  },
+  "keywords": [
+    "excel",
+    "formula",
+    "spreadsheet",
+    "javascript",
+    "js",
+    "parser",
+    "excel-formula"
+  ],
+  "files": [
+    "dist",
+    "index.d.ts"
+  ],
+  "author": "Lester(Dishu) Lyu",
+  "license": "MIT",
+  "dependencies": {
+    "@rowsncolumns/utils": ">=9.2.35",
+    "bahttext": "^2.3.0",
+    "bessel": "^1.0.2",
+    "chevrotain": "^10.5.0",
+    "jstat": "^1.9.6",
+    "jsonpath-plus": "^10.2.0"
+  },
+  "devDependencies": {
+    "@babel/preset-env": "^7.29.7",
+    "@babel/preset-react": "^7.29.7",
+    "@babel/preset-typescript": "^7.29.7",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rowsncolumns/common-types": ">=5.2.29",
+    "rollup": "^4.41.1"
+  }
+}