@univerjs/engine-formula 0.2.8 → 0.2.10

package/lib/types/functions/financial/pricemat/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/pricemat/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Pricemat extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(settlement: BaseValueObject, maturity: BaseValueObject, issue: BaseValueObject, rate: BaseValueObject, yld: BaseValueObject, basis?: BaseValueObject): BaseValueObject;
+    private _getDateCorrectOrder;
+}

package/lib/types/functions/financial/received/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/received/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Received extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(settlement: BaseValueObject, maturity: BaseValueObject, investment: BaseValueObject, discount: BaseValueObject, basis?: BaseValueObject): BaseValueObject;
+}

package/lib/types/functions/financial/rri/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/rri/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Rri extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(nper: BaseValueObject, pv: BaseValueObject, fv: BaseValueObject): BaseValueObject;
+}

package/lib/types/functions/financial/sln/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/sln/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Sln extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(cost: BaseValueObject, salvage: BaseValueObject, life: BaseValueObject): BaseValueObject;
+}

package/lib/types/functions/financial/syd/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/syd/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Syd extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(cost: BaseValueObject, salvage: BaseValueObject, life: BaseValueObject, per: BaseValueObject): BaseValueObject;
+}

package/lib/types/functions/financial/tbilleq/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/tbilleq/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Tbilleq extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(settlement: BaseValueObject, maturity: BaseValueObject, discount: BaseValueObject): BaseValueObject;
+}

package/lib/types/functions/financial/tbillprice/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/tbillprice/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Tbillprice extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(settlement: BaseValueObject, maturity: BaseValueObject, discount: BaseValueObject): BaseValueObject;
+}

package/lib/types/functions/financial/tbillyield/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/tbillyield/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Tbillyield extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(settlement: BaseValueObject, maturity: BaseValueObject, pr: BaseValueObject): BaseValueObject;
+}

package/lib/types/functions/financial/vdb/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/vdb/index.d.ts

@@ -0,0 +1,10 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Vdb extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(cost: BaseValueObject, salvage: BaseValueObject, life: BaseValueObject, startPeriod: BaseValueObject, endPeriod: BaseValueObject, factor?: BaseValueObject, noSwitch?: BaseValueObject): BaseValueObject;
+    private _getResultArray;
+    private _getResult;
+    private _getVdb;
+}

package/lib/types/functions/financial/xirr/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/xirr/index.d.ts

@@ -0,0 +1,12 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Xirr extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(values: BaseValueObject, dates: BaseValueObject, guess?: BaseValueObject): BaseValueObject;
+    private _checkErrors;
+    private _checkErrorValues;
+    private _checkErrorDates;
+    private _checkValues;
+    private _iterF;
+}

package/lib/types/functions/financial/xnpv/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/xnpv/index.d.ts

@@ -0,0 +1,10 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Xnpv extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(rate: BaseValueObject, values: BaseValueObject, dates: BaseValueObject): BaseValueObject;
+    private _checkErrors;
+    private _checkErrorValues;
+    private _checkErrorDates;
+}

package/lib/types/functions/financial/yield/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/yield/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Yield extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(settlement: BaseValueObject, maturity: BaseValueObject, rate: BaseValueObject, pr: BaseValueObject, redemption: BaseValueObject, frequency: BaseValueObject, basis?: BaseValueObject): BaseValueObject;
+    private _getResult;
+}

package/lib/types/functions/financial/yielddisc/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/yielddisc/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Yielddisc extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(settlement: BaseValueObject, maturity: BaseValueObject, pr: BaseValueObject, redemption: BaseValueObject, basis?: BaseValueObject): BaseValueObject;
+}

package/lib/types/functions/financial/yieldmat/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/financial/yieldmat/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class Yieldmat extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    calculate(settlement: BaseValueObject, maturity: BaseValueObject, issue: BaseValueObject, rate: BaseValueObject, pr: BaseValueObject, basis?: BaseValueObject): BaseValueObject;
+    private _getDateCorrectOrder;
+}

package/lib/types/functions/statistical/rank-avg/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/statistical/rank-avg/index.d.ts

@@ -0,0 +1,11 @@
+import { FunctionVariantType } from '../../../engine/reference-object/base-reference-object';
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class RankAvg extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    needsReferenceObject: boolean;
+    calculate(number: FunctionVariantType, ref: FunctionVariantType, order?: FunctionVariantType): BaseValueObject;
+    private _getResult;
+    private _checkRefReferenceObject;
+}

package/lib/types/functions/statistical/rank-eq/__tests__/index.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export {};

package/lib/types/functions/statistical/rank-eq/index.d.ts

@@ -0,0 +1,10 @@
+import { FunctionVariantType } from '../../../engine/reference-object/base-reference-object';
+import { BaseValueObject } from '../../../engine/value-object/base-value-object';
+import { BaseFunction } from '../../base-function';
+export declare class RankEq extends BaseFunction {
+    minParams: number;
+    maxParams: number;
+    needsReferenceObject: boolean;
+    calculate(number: FunctionVariantType, ref: FunctionVariantType, order?: FunctionVariantType): BaseValueObject;
+    private _checkRefReferenceObject;
+}

package/lib/types/index.d.ts

@@ -81,15 +81,34 @@ export { FormulaExecutedStateType, type IAllRuntimeData } from './services/runti
 export { isReferenceString } from './basics/regex';
 export { matchRefDrawToken } from './basics/match-token';
 export { IDefinedNamesService, DefinedNamesService, type IDefinedNamesServiceParam, type IDefinedNameMapItem } from './services/defined-names.service';
-export { isFormulaTransformable, transformFormula } from './engine/utils/relative-formula';
 export { IFormulaRuntimeService, FormulaRuntimeService } from './services/runtime.service';
 export { IFormulaCurrentConfigService, FormulaCurrentConfigService, type IFormulaDirtyData } from './services/current-data.service';
 export { IActiveDirtyManagerService } from './services/active-dirty-manager.service';
+export { ActiveDirtyManagerService } from './services/active-dirty-manager.service';
 export type { IRangeChange } from './models/formula-data.model';
 export { handleNumfmtInCell } from './engine/utils/numfmt-kit';
 export { AsyncArrayObject } from './engine/reference-object/base-reference-object';
 export { strip, stripErrorMargin } from './engine/utils/math-kit';
 export { AsyncObject } from './engine/reference-object/base-reference-object';
+export { Lexer } from './engine/analysis/lexer';
+export { FormulaDependencyGenerator } from './engine/dependency/formula-dependency';
+export { ISuperTableService } from './services/super-table.service';
+export { SuperTableService } from './services/super-table.service';
+export { Interpreter } from './engine/interpreter/interpreter';
+export { AstTreeBuilder } from './engine/analysis/parser';
+export { AstRootNodeFactory } from './engine/ast-node/ast-root-node';
+export { FunctionNodeFactory } from './engine/ast-node/function-node';
+export { LambdaNodeFactory } from './engine/ast-node/lambda-node';
+export { LambdaParameterNodeFactory } from './engine/ast-node/lambda-parameter-node';
+export { OperatorNodeFactory } from './engine/ast-node/operator-node';
+export { PrefixNodeFactory } from './engine/ast-node/prefix-node';
+export { ReferenceNodeFactory } from './engine/ast-node/reference-node';
+export { SuffixNodeFactory } from './engine/ast-node/suffix-node';
+export { UnionNodeFactory } from './engine/ast-node/union-node';
+export { ValueNodeFactory } from './engine/ast-node/value-node';
+export { IDependencyManagerService } from './services/dependency-manager.service';
+export { DependencyManagerService } from './services/dependency-manager.service';
+export { CalculateController } from './controller/calculate.controller';
 export { RegisterFunctionMutation } from './commands/mutations/register-function.mutation';
 export { type ISetArrayFormulaDataMutationParams, SetArrayFormulaDataMutation } from './commands/mutations/set-array-formula-data.mutation';
 export { RemoveDefinedNameMutation, SetDefinedNameMutation, type ISetDefinedNameMutationSearchParam, type ISetDefinedNameMutationParam } from './commands/mutations/set-defined-name.mutation';

package/lib/types/services/function.service.d.ts

@@ -26,6 +26,7 @@ export interface IFunctionService {
     hasDescription(functionToken: IFunctionNames): boolean;
     unregisterDescriptions(...functionTokens: IFunctionNames[]): void;
 }
+export declare const IFunctionService: import('@univerjs/core').IdentifierDecorator<FunctionService>;
 export declare class FunctionService extends Disposable implements IFunctionService {
     private _functionExecutors;
     private _functionDescriptions;
@@ -41,4 +42,3 @@ export declare class FunctionService extends Disposable implements IFunctionServ
     hasDescription(functionToken: IFunctionNames): boolean;
     unregisterDescriptions(...functionTokens: IFunctionNames[]): void;
 }
-export declare const IFunctionService: import('@univerjs/core').IdentifierDecorator<FunctionService>;