@univerjs/engine-formula 0.1.2 → 0.1.3

package/lib/types/basics/common.d.ts

@@ -48,6 +48,11 @@ export interface IRuntimeUnitDataType {
         [sheetId: string]: ObjectMatrix<Nullable<ICellData>>;
     }>;
 }
+export interface IRuntimeUnitDataPrimitiveType {
+    [unitId: string]: Nullable<{
+        [sheetId: string]: IObjectMatrixPrimitiveType<Nullable<ICellData>>;
+    }>;
+}
 export interface IRuntimeOtherUnitDataType {
     [unitId: string]: Nullable<{
         [sheetId: string]: Nullable<{
@@ -82,10 +87,7 @@ export interface IFeatureDirtyRangeType {
         [sheetId: string]: IRange[];
     }>;
 }
-export interface IArrayFormulaUnitCellType {
-    [unitId: string]: Nullable<{
-        [sheetId: string]: IObjectMatrixPrimitiveType<Nullable<ICellData>>;
-    }>;
+export interface IArrayFormulaUnitCellType extends IRuntimeUnitDataPrimitiveType {
 }
 export interface IFormulaData {
     [unitId: string]: Nullable<{

package/lib/types/basics/match-token.d.ts

@@ -18,3 +18,8 @@ export declare const FORMULA_LEXER_TOKENS: (operatorToken | suffixToken | compar
 export declare function isFormulaLexerToken(str: string): boolean;
 export declare function includeFormulaLexerToken(str: string): boolean;
 export declare function normalizeSheetName(sheetName: string): string;
+/**
+ * Determine whether the character is a token keyword for the formula engine.
+ * @param char
+ */
+export declare function matchRefDrawToken(char: string): boolean;

package/lib/types/basics/runtime.d.ts

@@ -13,5 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IArrayFormulaUnitCellType, IRuntimeUnitDataType } from './common';
+import type { IArrayFormulaUnitCellType, IRuntimeUnitDataPrimitiveType, IRuntimeUnitDataType } from './common';
 export declare function convertUnitDataToRuntime(unitData: IArrayFormulaUnitCellType): IRuntimeUnitDataType;
+export declare function convertRuntimeToUnitData(unitData: IRuntimeUnitDataType): IRuntimeUnitDataPrimitiveType;

package/lib/types/basics/token-type.d.ts

@@ -20,3 +20,4 @@ export declare const DEFAULT_TOKEN_TYPE_LAMBDA_RUNTIME_PARAMETER = "LR_1";
 export declare const DEFAULT_TOKEN_TYPE_LAMBDA_OMIT_PARAMETER = "LO_1";
 export declare const DEFAULT_TOKEN_LET_FUNCTION_NAME = "LET";
 export declare const DEFAULT_TOKEN_LAMBDA_FUNCTION_NAME = "LAMBDA";
+export declare const DEFAULT_TOKEN_CUBE_FUNCTION_NAME = "CUBE";

package/lib/types/basics/token.d.ts

@@ -59,3 +59,4 @@ export declare enum prefixToken {
     AT = "@",
     MINUS = "-"
 }
+export declare const SPACE_TOKEN = " ";

package/lib/types/commands/mutations/set-formula-calculation.mutation.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { IExecutionOptions, IMutation, IUnitRange, Nullable } from '@univerjs/core';
-import type { IDirtyUnitFeatureMap, IDirtyUnitSheetNameMap, INumfmtItemMap, IRuntimeOtherUnitDataType, IRuntimeUnitDataType } from '../../basics/common';
+import type { IDirtyUnitFeatureMap, IDirtyUnitSheetNameMap, INumfmtItemMap, IRuntimeOtherUnitDataType, IRuntimeUnitDataPrimitiveType } from '../../basics/common';
 import type { FormulaExecutedStateType, IExecutionInProgressParams } from '../../services/runtime.service';
 export interface ISetFormulaCalculationStartMutation {
     dirtyRanges: IUnitRange[];
@@ -38,7 +38,7 @@ export interface ISetFormulaCalculationNotificationMutation {
 }
 export declare const SetFormulaCalculationNotificationMutation: IMutation<ISetFormulaCalculationNotificationMutation>;
 export interface ISetFormulaCalculationResultMutation {
-    unitData: IRuntimeUnitDataType;
+    unitData: IRuntimeUnitDataPrimitiveType;
     unitOtherData: IRuntimeOtherUnitDataType;
 }
 export declare const SetFormulaCalculationResultMutation: IMutation<ISetFormulaCalculationResultMutation>;

package/lib/types/engine/analysis/lexer-tree-builder.d.ts

@@ -52,7 +52,6 @@ export declare class LexerTreeBuilder extends Disposable {
     /**
      * Estimate the number of right brackets that need to be automatically added to the end of the formula.
      * @param formulaString
-     * @returns
      */
     checkIfAddBracket(formulaString: string): number;
     sequenceNodesBuilder(formulaString: string): (string | ISequenceNode)[] | undefined;
@@ -72,6 +71,10 @@ export declare class LexerTreeBuilder extends Disposable {
         hasDefinedName: boolean;
     }): ErrorType.VALUE | LexerNode | (string | LexerNode)[] | undefined;
     private _suffixExpressionHandler;
+    private _checkCloseBracket;
+    private _checkOpenBracket;
+    private _checkOperator;
+    private _deletePlusForPreNode;
     private _resetCurrentLexerNode;
     private _resetSegment;
     private _openBracket;
@@ -79,6 +82,7 @@ export declare class LexerTreeBuilder extends Disposable {
     private _openSquareBracket;
     private _closeSquareBracket;
     private _getCurrentBracket;
+    private _changeCurrentBracket;
     private _openBraces;
     private _closeBraces;
     private _openSingleQuotation;

package/lib/types/engine/analysis/parser.d.ts

@@ -48,7 +48,6 @@ export declare class AstTreeBuilder extends Disposable {
     parse(lexerNode: LexerNode, refOffsetX?: number, refOffsetY?: number): Nullable<BaseAstNode>;
     private _lambdaParameterHandler;
     private _changeLetToLambda;
-    private _getTopParent;
     private _parse;
     private _checkAstNode;
     private _initializeAstNode;

package/lib/types/engine/ast-node/reference-node.d.ts

@@ -18,9 +18,9 @@ import { Injector } from '@wendellhu/redi';
 import { IDefinedNamesService } from '../../services/defined-names.service';
 import { IFormulaRuntimeService } from '../../services/runtime.service';
 import { ISuperTableService } from '../../services/super-table.service';
-import { Lexer } from '../analysis/lexer';
 import { LexerNode } from '../analysis/lexer-node';
 import type { BaseReferenceObject } from '../reference-object/base-reference-object';
+import { IFunctionService } from '../../services/function.service';
 import { BaseAstNode } from './base-ast-node';
 import { BaseAstNodeFactory } from './base-ast-node-factory';
 import { NodeType } from './node-type';
@@ -37,9 +37,9 @@ export declare class ReferenceNodeFactory extends BaseAstNodeFactory {
     private readonly _definedNamesService;
     private readonly _superTableService;
     private readonly _formulaRuntimeService;
-    private readonly _lexer;
+    private readonly _functionService;
     private readonly _injector;
-    constructor(_definedNamesService: IDefinedNamesService, _superTableService: ISuperTableService, _formulaRuntimeService: IFormulaRuntimeService, _lexer: Lexer, _injector: Injector);
+    constructor(_definedNamesService: IDefinedNamesService, _superTableService: ISuperTableService, _formulaRuntimeService: IFormulaRuntimeService, _functionService: IFunctionService, _injector: Injector);
     get zIndex(): number;
     checkAndCreateNodeType(param: LexerNode | string): ReferenceNode | undefined;
 }

package/lib/types/engine/utils/ast-node-tool.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum 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.
+ */
+import type { Nullable } from '@univerjs/core';
+import type { BaseAstNode } from '../ast-node/base-ast-node';
+export declare function getAstNodeTopParent(node: BaseAstNode): Nullable<BaseAstNode>;

package/lib/types/engine/utils/compare.d.ts

@@ -28,3 +28,4 @@ export declare function isWildcard(str: string): boolean;
 export declare function isMatchWildcard(currentValue: string, value: string): boolean;
 export declare function replaceWildcard(value: string): string;
 export declare function compareWithWildcard(currentValue: string, value: string, operator: compareToken): boolean;
+export declare function escapeRegExp(str: string): string;

package/lib/types/engine/utils/prefixHandler.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright 2023-present DreamNum 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.
+ */
+import type { Injector } from '@wendellhu/redi';
+import type { Nullable } from '@univerjs/core';
+import type { IFunctionService } from '../../services/function.service';
+import { PrefixNode } from '../ast-node/prefix-node';
+export declare function prefixHandler(tokenTrim: string, functionService: IFunctionService, injector: Injector): {
+    tokenTrim: string;
+    minusPrefixNode: Nullable<PrefixNode>;
+    atPrefixNode: Nullable<PrefixNode>;
+};

package/lib/types/engine/utils/r1c1-reference.d.ts

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { type IRange } from '@univerjs/core';
-import type { IGridRangeName } from './reference';
-export declare function deserializeRangeForR1C1(refString: string, currentRow?: number, currentColumn?: number): IGridRangeName;
+import type { IRange, IUnitRangeName } from '@univerjs/core';
+export declare function deserializeRangeForR1C1(refString: string, currentRow?: number, currentColumn?: number): IUnitRangeName;
 export declare function serializeRangeToR1C1(range: IRange): string;

package/lib/types/engine/utils/reference.d.ts

@@ -13,13 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IRange } from '@univerjs/core';
+import type { IRange, IUnitRangeName } from '@univerjs/core';
 import { AbsoluteRefType } from '@univerjs/core';
-export interface IGridRangeName {
-    unitId: string;
-    sheetName: string;
-    range: IRange;
-}
 export interface IAbsoluteRefTypeForRange {
     startAbsoluteRefType: AbsoluteRefType;
     endAbsoluteRefType?: AbsoluteRefType;
@@ -52,13 +47,13 @@ export declare function serializeRangeWithSheet(sheetName: string, range: IRange
  * @param range
  */
 export declare function serializeRangeWithSpreadsheet(unit: string, sheetName: string, range: IRange): string;
-export declare function serializeRangeToRefString(gridRangeName: IGridRangeName): string;
+export declare function serializeRangeToRefString(gridRangeName: IUnitRangeName): string;
 export declare function handleRefStringInfo(refString: string): {
     refBody: string;
     sheetName: string;
     unitId: string;
 };
-export declare function deserializeRangeWithSheet(refString: string): IGridRangeName;
+export declare function deserializeRangeWithSheet(refString: string): IUnitRangeName;
 /**
  * Determine whether the sheet name needs to be wrapped in quotes
  * Excel will quote the worksheet name if any of the following is true:

package/lib/types/engine/value-object/base-value-object.d.ts

@@ -46,6 +46,7 @@ export declare class BaseValueObject extends ObjectClassType {
     getArrayValue(): BaseValueObject[][];
     setValue(value: string | number | boolean): void;
     setArrayValue(value: BaseValueObject[][]): void;
+    isCube(): boolean;
     isArray(): boolean;
     isString(): boolean;
     isNumber(): boolean;

package/lib/types/engine/value-object/cube-value-object.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright 2023-present DreamNum 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.
+ */
+import type { ArrayValueObject } from './array-value-object';
+import { BaseValueObject } from './base-value-object';
+import { NumberValueObject } from './primitive-object';
+export declare class CubeValueObject extends BaseValueObject {
+    isCube(): boolean;
+    private _values;
+    constructor(values: ArrayValueObject[]);
+    sum(): NumberValueObject;
+    max(): NumberValueObject;
+    min(): NumberValueObject;
+    count(): NumberValueObject;
+    countA(): NumberValueObject;
+    countBlank(): NumberValueObject;
+}

package/lib/types/functions/meta/cube/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023-present DreamNum 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.
+ */
+import type { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Cube extends BaseFunction {
+    calculate(...variants: BaseValueObject[]): BaseValueObject;
+}

package/lib/types/functions/meta/function-map.d.ts

@@ -13,6 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Divided } from './divided';
+import { Cube } from './cube';
 import { FUNCTION_NAMES_META } from './function-names';
-export declare const functionMeta: (FUNCTION_NAMES_META | typeof Divided)[][];
+export declare const functionMeta: (FUNCTION_NAMES_META | typeof Cube)[][];

package/lib/types/functions/meta/function-names.d.ts

@@ -19,5 +19,6 @@ export declare enum FUNCTION_NAMES_META {
     MINUS = "MINUS",
     MULTIPLY = "MULTIPLY",
     PLUS = "PLUS",
-    UNION = "UNION"
+    UNION = "UNION",
+    CUBE = "CUBE"
 }

package/lib/types/index.d.ts

@@ -88,3 +88,4 @@ export { FormulaExecutedStateType, type IAllRuntimeData } from './services/runti
 export { SetNumfmtFormulaDataMutation } from './commands/mutations/set-numfmt-formula-data.mutation';
 export type { ISetNumfmtFormulaDataMutationParams } from './commands/mutations/set-numfmt-formula-data.mutation';
 export { isReferenceString } from './basics/regex';
+export { matchRefDrawToken } from './basics/match-token';