@univerjs/engine-formula 0.1.3 → 0.1.4

package/lib/types/functions/lookup/index/index.d.ts

@@ -13,12 +13,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { ArrayValueObject } from '../../../engine/value-object/array-value-object';
+import type { BaseReferenceObject } from '../../../engine/reference-object/base-reference-object';
 import { type BaseValueObject } from '../../../engine/value-object/base-value-object';
 import { BaseFunction } from '../../base-function';
+/**
+ * The result of the INDEX function is a reference and is interpreted as such by other formulas. Depending on the formula, the return value of INDEX may be used as a reference or as a value.
+ *
+ * =INDEX(A2:A5,2,1):A1 same as =A1:A3
+ *
+ * OPTIMIZE: maybe we can remove some unknown type
+ */
 export declare class Index extends BaseFunction {
-    calculate(reference: BaseValueObject, rowNum: BaseValueObject, columnNum?: BaseValueObject, areaNum?: BaseValueObject): BaseValueObject | ArrayValueObject;
+    needsReferenceObject: boolean;
+    calculate(referenceObject: BaseValueObject, rowNum: BaseValueObject, columnNum?: BaseValueObject, areaNum?: BaseValueObject): BaseValueObject | BaseReferenceObject;
     private _calculateSingleCell;
     private _getNumberValue;
     private _getAreaNumberValue;
+    private _getReferenceObject;
 }

package/lib/types/functions/lookup/offset/index.d.ts

@@ -17,6 +17,6 @@ import type { BaseReferenceObject } from '../../../engine/reference-object/base-
 import type { BaseValueObject } from '../../../engine/value-object/base-value-object';
 import { BaseFunction } from '../../base-function';
 export declare class Offset extends BaseFunction {
-    calculate(reference: BaseValueObject, rows: BaseValueObject, columns: BaseValueObject, height?: BaseValueObject, width?: BaseValueObject): BaseValueObject | BaseReferenceObject;
-    private _setDefault;
+    needsReferenceObject: boolean;
+    calculate(referenceObject: BaseValueObject, rows: BaseValueObject, columns: BaseValueObject, height?: BaseValueObject, width?: BaseValueObject): BaseValueObject | BaseReferenceObject;
 }

package/lib/types/functions/text/len/__test__/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/text/len/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 Len extends BaseFunction {
+    calculate(text: BaseValueObject): BaseValueObject;
+    private _handleSingleText;
+}

package/lib/types/functions/text/lenb/__test__/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/text/lenb/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 Lenb extends BaseFunction {
+    calculate(text: BaseValueObject): BaseValueObject;
+    private _handleSingleText;
+}

package/lib/types/functions/text/text/__test__/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/text/text/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 Text extends BaseFunction {
+    calculate(text: BaseValueObject, formatText: BaseValueObject): BaseValueObject;
+}

package/lib/types/index.d.ts

@@ -89,3 +89,6 @@ export { SetNumfmtFormulaDataMutation } from './commands/mutations/set-numfmt-fo
 export type { ISetNumfmtFormulaDataMutationParams } from './commands/mutations/set-numfmt-formula-data.mutation';
 export { isReferenceString } from './basics/regex';
 export { matchRefDrawToken } from './basics/match-token';
+export { IDefinedNamesService, DefinedNamesService } from './services/defined-names.service';
+export { IFormulaRuntimeService, FormulaRuntimeService } from './services/runtime.service';
+export { IFormulaCurrentConfigService, FormulaCurrentConfigService } from './services/current-data.service';

package/lib/types/plugin.d.ts

@@ -20,7 +20,7 @@ import type { IFunctionNames } from './basics/function';
 import type { BaseFunction } from './functions/base-function';
 interface IUniverFormulaEngine {
     notExecuteFormula?: boolean;
-    function: Array<[Ctor<BaseFunction>, IFunctionNames]>;
+    function?: Array<[Ctor<BaseFunction>, IFunctionNames]>;
 }
 export declare class UniverFormulaEnginePlugin extends Plugin {
     private _config;

package/lib/types/services/current-data.service.d.ts

@@ -32,6 +32,7 @@ export interface IFormulaCurrentConfigService {
     getExcludedRange(): Nullable<IUnitExcludedCell>;
     loadDirtyRangesAndExcludedCell(dirtyRanges: IUnitRange[], excludedCell?: IUnitExcludedCell): void;
     getArrayFormulaCellData(): IRuntimeUnitDataType;
+    getSheetName(unitId: string, sheetId: string): string;
 }
 export declare class FormulaCurrentConfigService extends Disposable implements IFormulaCurrentConfigService {
     private readonly _currentUniverService;
@@ -45,6 +46,7 @@ export declare class FormulaCurrentConfigService extends Disposable implements I
     private _numfmtItemMap;
     private _dirtyUnitFeatureMap;
     private _excludedCell;
+    private _sheetIdToNameMap;
     constructor(_currentUniverService: IUniverInstanceService);
     dispose(): void;
     getExcludedRange(): Nullable<IUnitExcludedCell>;
@@ -57,6 +59,7 @@ export declare class FormulaCurrentConfigService extends Disposable implements I
     getDirtyNameMap(): IDirtyUnitSheetNameMap;
     getNumfmtItemMap(): INumfmtItemMap;
     getDirtyUnitFeatureMap(): IDirtyUnitFeatureMap;
+    getSheetName(unitId: string, sheetId: string): string;
     load(config: IFormulaDatasetConfig): void;
     loadDirtyRangesAndExcludedCell(dirtyRanges: IUnitRange[], excludedCell?: IUnitExcludedCell): void;
     registerUnitData(unitData: IUnitData): void;