@univerjs/engine-formula 0.5.2 → 0.5.3

package/lib/types/basics/is-null-cell.d.ts

@@ -0,0 +1,7 @@
+import { ICellData, Nullable } from '@univerjs/core';
+/**
+ * Examine if a cell is empty (null) in the formula-related modules. This is not
+ * interchangable with {@link isNullCell} from the core package, because for
+ * formulas, "custom" field is meaningless.
+ */
+export declare function isNullCellForFormula(cell: Nullable<ICellData>): boolean;

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

@@ -32,7 +32,14 @@ export declare class FunctionNode extends BaseAstNode {
      *    the LOOKUP function will continue using the last value of the result_vector for lookup and returning results after the last value of the lookup_vector.
      */
     private _lookupCompatibility;
+    /**
+     * Transform the result of a custom function to a NodeValueType.
+     */
+    private _handleCustomResult;
+    private _handleAddressFunction;
+    private _mapVariantsToValues;
     private _calculate;
+    private _calculateAsync;
     private _setDefinedNamesForFunction;
     private _setRefInfo;
     private _setRefData;

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

@@ -2,6 +2,7 @@ import { FormulaAstLRU } from '../../basics/cache-lru';
 import { compareToken } from '../../basics/token';
 import { BaseValueObject, ErrorValueObject } from './base-value-object';
 export type PrimitiveValueType = string | boolean | number | null;
+export type FormulaFunctionValueType = PrimitiveValueType | PrimitiveValueType[][];
 export declare class NullValueObject extends BaseValueObject {
     private static _instance;
     static create(): NullValueObject;

package/lib/types/facade/f-formula.d.ts

@@ -4,10 +4,11 @@ import { FormulaExecutedStateType, IExecutionInProgressParams } from '@univerjs/
  * This interface class provides methods to modify the behavior of the operation formula.
  */
 export declare class FFormula extends FBase {
-    private readonly _commandService;
+    protected readonly _commandService: ICommandService;
     protected readonly _injector: Injector;
     protected readonly _configService: IConfigService;
     constructor(_commandService: ICommandService, _injector: Injector, _configService: IConfigService);
+    _initialize(): void;
     /**
      * Start the calculation of the formula.
      */

package/lib/types/functions/base-function.d.ts

@@ -3,10 +3,10 @@ import { IFunctionNames } from '../basics/function';
 import { BaseReferenceObject, FunctionVariantType, NodeValueType } from '../engine/reference-object/base-reference-object';
 import { ArrayBinarySearchType, ArrayOrderSearchType } from '../engine/utils/compare';
 import { ArrayValueObject } from '../engine/value-object/array-value-object';
+import { FormulaFunctionValueType } from '../engine/value-object/primitive-object';
 import { FormulaDataModel } from '../models/formula-data.model';
 import { IDefinedNameMapItem } from '../services/defined-names.service';
 import { BaseValueObject, ErrorValueObject } from '../engine/value-object/base-value-object';
-import { PrimitiveValueType } from '../engine/value-object/primitive-object';
 export declare class BaseFunction {
     private _name;
     private _unitId;
@@ -87,7 +87,7 @@ export declare class BaseFunction {
     isAddress(): boolean;
     isCustom(): boolean;
     setRefInfo(unitId: string, subUnitId: string, row: number, column: number): void;
-    calculateCustom(...arg: Array<PrimitiveValueType | PrimitiveValueType[][]>): PrimitiveValueType | PrimitiveValueType[][];
+    calculateCustom(...arg: Array<FormulaFunctionValueType>): FormulaFunctionValueType | Promise<FormulaFunctionValueType>;
     calculate(...arg: BaseValueObject[]): NodeValueType;
     checkArrayType(variant: FunctionVariantType): boolean;
     /**

package/lib/types/functions/custom-function.d.ts

@@ -2,3 +2,6 @@ import { BaseFunction } from './base-function';
 export declare class CustomFunction extends BaseFunction {
     isCustom(): boolean;
 }
+export declare class AsyncCustomFunction extends CustomFunction {
+    isAsync(): boolean;
+}

package/lib/types/index.d.ts

@@ -61,7 +61,7 @@ export { handleRefStringInfo } from './engine/utils/reference';
 export { generateStringWithSequence, type ISequenceNode, sequenceNodeType } from './engine/utils/sequence';
 export { ArrayValueObject, ValueObjectFactory } from './engine/value-object/array-value-object';
 export { BaseValueObject, ErrorValueObject } from './engine/value-object/base-value-object';
-export type { PrimitiveValueType } from './engine/value-object/primitive-object';
+export type { FormulaFunctionValueType, PrimitiveValueType } from './engine/value-object/primitive-object';
 export { BooleanValueObject, NullValueObject, NumberValueObject, StringValueObject } from './engine/value-object/primitive-object';
 export { functionArray } from './functions/array/function-map';
 export { FUNCTION_NAMES_ARRAY } from './functions/array/function-names';
@@ -70,7 +70,7 @@ export { functionCompatibility } from './functions/compatibility/function-map';
 export { FUNCTION_NAMES_COMPATIBILITY } from './functions/compatibility/function-names';
 export { functionCube } from './functions/cube/function-map';
 export { FUNCTION_NAMES_CUBE } from './functions/cube/function-names';
-export { CustomFunction } from './functions/custom-function';
+export { AsyncCustomFunction, CustomFunction } from './functions/custom-function';
 export { functionDatabase } from './functions/database/function-map';
 export { FUNCTION_NAMES_DATABASE } from './functions/database/function-names';
 export { functionDate } from './functions/date/function-map';

package/lib/umd/facade.js

@@ -1 +1 @@
-(function(a,n){typeof exports=="object"&&typeof module<"u"?n(exports,require("@univerjs/core"),require("@univerjs/engine-formula")):typeof define=="function"&&define.amd?define(["exports","@univerjs/core","@univerjs/engine-formula"],n):(a=typeof globalThis<"u"?globalThis:a||self,n(a.UniverEngineFormulaFacade={},a.UniverCore,a.UniverEngineFormula))})(this,function(a,n,r){"use strict";var m=Object.defineProperty,d=Object.getOwnPropertyDescriptor,f=(u,e,t,i)=>{for(var o=i>1?void 0:i?d(e,t):e,s=u.length-1,l;s>=0;s--)(l=u[s])&&(o=(i?l(e,t,o):l(o))||o);return i&&o&&m(e,t,o),o},c=(u,e)=>(t,i)=>e(t,i,u);a.FFormula=class extends n.FBase{constructor(e,t,i){super(),this._commandService=e,this._injector=t,this._configService=i}executeCalculation(){this._commandService.executeCommand(r.SetFormulaCalculationStartMutation.id,{commands:[],forceCalculation:!0},{onlyLocal:!0})}stopCalculation(){this._commandService.executeCommand(r.SetFormulaCalculationStopMutation.id,{})}calculationStart(e){return this._commandService.onCommandExecuted(t=>{if(t.id===r.SetFormulaCalculationStartMutation.id){const i=t.params;e(i.forceCalculation)}})}calculationEnd(e){return this._commandService.onCommandExecuted(t=>{if(t.id!==r.SetFormulaCalculationNotificationMutation.id)return;const i=t.params;i.functionsExecutedState!==void 0&&e(i.functionsExecutedState)})}onCalculationEnd(){return new Promise((e,t)=>{const i=setTimeout(()=>{t(new Error("Calculation end timeout"))},3e4),o=this.calculationEnd(()=>{clearTimeout(i),o.dispose(),e()})})}calculationProcessing(e){return this._commandService.onCommandExecuted(t=>{if(t.id!==r.SetFormulaCalculationNotificationMutation.id)return;const i=t.params;i.stageInfo!==void 0&&e(i.stageInfo)})}setMaxIteration(e){this._configService.setConfig(r.ENGINE_FORMULA_CYCLE_REFERENCE_COUNT,e)}},a.FFormula=f([c(0,n.Inject(n.ICommandService)),c(1,n.Inject(n.Injector)),c(2,n.IConfigService)],a.FFormula);class v extends n.FUniver{getFormula(){return this._injector.createInstance(a.FFormula)}}n.FUniver.extend(v),Object.defineProperty(a,Symbol.toStringTag,{value:"Module"})});
+(function(a,n){typeof exports=="object"&&typeof module<"u"?n(exports,require("@univerjs/core"),require("@univerjs/engine-formula")):typeof define=="function"&&define.amd?define(["exports","@univerjs/core","@univerjs/engine-formula"],n):(a=typeof globalThis<"u"?globalThis:a||self,n(a.UniverEngineFormulaFacade={},a.UniverCore,a.UniverEngineFormula))})(this,function(a,n,r){"use strict";var m=Object.defineProperty,d=Object.getOwnPropertyDescriptor,f=(u,e,t,i)=>{for(var o=i>1?void 0:i?d(e,t):e,s=u.length-1,l;s>=0;s--)(l=u[s])&&(o=(i?l(e,t,o):l(o))||o);return i&&o&&m(e,t,o),o},c=(u,e)=>(t,i)=>e(t,i,u);a.FFormula=class extends n.FBase{constructor(e,t,i){super(),this._commandService=e,this._injector=t,this._configService=i,this._initialize()}_initialize(){}executeCalculation(){this._commandService.executeCommand(r.SetFormulaCalculationStartMutation.id,{commands:[],forceCalculation:!0},{onlyLocal:!0})}stopCalculation(){this._commandService.executeCommand(r.SetFormulaCalculationStopMutation.id,{})}calculationStart(e){return this._commandService.onCommandExecuted(t=>{if(t.id===r.SetFormulaCalculationStartMutation.id){const i=t.params;e(i.forceCalculation)}})}calculationEnd(e){return this._commandService.onCommandExecuted(t=>{if(t.id!==r.SetFormulaCalculationNotificationMutation.id)return;const i=t.params;i.functionsExecutedState!==void 0&&e(i.functionsExecutedState)})}onCalculationEnd(){return new Promise((e,t)=>{const i=setTimeout(()=>{t(new Error("Calculation end timeout"))},3e4),o=this.calculationEnd(()=>{clearTimeout(i),o.dispose(),e()})})}calculationProcessing(e){return this._commandService.onCommandExecuted(t=>{if(t.id!==r.SetFormulaCalculationNotificationMutation.id)return;const i=t.params;i.stageInfo!==void 0&&e(i.stageInfo)})}setMaxIteration(e){this._configService.setConfig(r.ENGINE_FORMULA_CYCLE_REFERENCE_COUNT,e)}},a.FFormula=f([c(0,n.Inject(n.ICommandService)),c(1,n.Inject(n.Injector)),c(2,n.IConfigService)],a.FFormula);class v extends n.FUniver{getFormula(){return this._injector.createInstance(a.FFormula)}}n.FUniver.extend(v),Object.defineProperty(a,Symbol.toStringTag,{value:"Module"})});