@univerjs/sheets-formula 0.1.0-beta.1 → 0.1.0-beta.2

package/lib/types/locale/zh-CN.d.ts

@@ -187,24 +187,6 @@ declare const _default: {
                     };
                 };
             };
-            CONCATENATE: {
-                description: string;
-                abstract: string;
-                links: {
-                    title: string;
-                    url: string;
-                }[];
-                functionParameter: {
-                    number1: {
-                        name: string;
-                        detail: string;
-                    };
-                    number2: {
-                        name: string;
-                        detail: string;
-                    };
-                };
-            };
             CONFIDENCE: {
                 description: string;
                 abstract: string;
@@ -313,42 +295,6 @@ declare const _default: {
                     };
                 };
             };
-            FLOOR: {
-                description: string;
-                abstract: string;
-                links: {
-                    title: string;
-                    url: string;
-                }[];
-                functionParameter: {
-                    number1: {
-                        name: string;
-                        detail: string;
-                    };
-                    number2: {
-                        name: string;
-                        detail: string;
-                    };
-                };
-            };
-            FORECAST: {
-                description: string;
-                abstract: string;
-                links: {
-                    title: string;
-                    url: string;
-                }[];
-                functionParameter: {
-                    number1: {
-                        name: string;
-                        detail: string;
-                    };
-                    number2: {
-                        name: string;
-                        detail: string;
-                    };
-                };
-            };
             FTEST: {
                 description: string;
                 abstract: string;
@@ -2445,11 +2391,11 @@ declare const _default: {
                     url: string;
                 }[];
                 functionParameter: {
-                    number1: {
+                    parameter: {
                         name: string;
                         detail: string;
                     };
-                    number2: {
+                    calculation: {
                         name: string;
                         detail: string;
                     };
@@ -2765,6 +2711,24 @@ declare const _default: {
                     };
                 };
             };
+            CONCATENATE: {
+                description: string;
+                abstract: string;
+                links: {
+                    title: string;
+                    url: string;
+                }[];
+                functionParameter: {
+                    number1: {
+                        name: string;
+                        detail: string;
+                    };
+                    number2: {
+                        name: string;
+                        detail: string;
+                    };
+                };
+            };
             DBCS: {
                 description: string;
                 abstract: string;
@@ -3691,11 +3655,23 @@ declare const _default: {
                     url: string;
                 }[];
                 functionParameter: {
-                    number1: {
+                    row_num: {
                         name: string;
                         detail: string;
                     };
-                    number2: {
+                    column_num: {
+                        name: string;
+                        detail: string;
+                    };
+                    abs_num: {
+                        name: string;
+                        detail: string;
+                    };
+                    a1: {
+                        name: string;
+                        detail: string;
+                    };
+                    sheet_text: {
                         name: string;
                         detail: string;
                     };
@@ -4249,11 +4225,19 @@ declare const _default: {
                     url: string;
                 }[];
                 functionParameter: {
-                    number1: {
+                    lookupValue: {
                         name: string;
                         detail: string;
                     };
-                    number2: {
+                    tableArray: {
+                        name: string;
+                        detail: string;
+                    };
+                    colIndexNum: {
+                        name: string;
+                        detail: string;
+                    };
+                    rangeLookup: {
                         name: string;
                         detail: string;
                     };
@@ -4961,6 +4945,24 @@ declare const _default: {
                     };
                 };
             };
+            FORECAST: {
+                description: string;
+                abstract: string;
+                links: {
+                    title: string;
+                    url: string;
+                }[];
+                functionParameter: {
+                    number1: {
+                        name: string;
+                        detail: string;
+                    };
+                    number2: {
+                        name: string;
+                        detail: string;
+                    };
+                };
+            };
             FORECAST_ETS: {
                 description: string;
                 abstract: string;
@@ -6853,6 +6855,24 @@ declare const _default: {
                     };
                 };
             };
+            FLOOR: {
+                description: string;
+                abstract: string;
+                links: {
+                    title: string;
+                    url: string;
+                }[];
+                functionParameter: {
+                    number1: {
+                        name: string;
+                        detail: string;
+                    };
+                    number2: {
+                        name: string;
+                        detail: string;
+                    };
+                };
+            };
             FLOOR_MATH: {
                 description: string;
                 abstract: string;
@@ -9220,6 +9240,7 @@ declare const _default: {
             web: string;
             array: string;
             univer: string;
+            user: string;
         };
         moreFunctions: {
             confirm: string;

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

@@ -50,12 +50,23 @@ export interface IDescriptionService {
      * @returns
      */
     getSearchListByType(type: number): ISearchItem[];
+    /**
+     * register descriptions
+     * @param functionList
+     */
+    registerDescriptions(functionList: IFunctionInfo[]): void;
+    /**
+     * unregister descriptions
+     * @param functionList
+     */
+    unregisterDescriptions(functionNames: string[]): void;
 }
 export declare const IDescriptionService: import("@wendellhu/redi").IdentifierDecorator<IDescriptionService>;
 export declare class DescriptionService implements IDescriptionService, IDisposable {
     private _description;
     private readonly _functionService;
     private readonly _localeService;
+    private _descriptions;
     constructor(_description: IFunctionInfo[], _functionService: IFunctionService, _localeService: LocaleService);
     dispose(): void;
     getDescriptions(): Map<IFunctionNames, IFunctionInfo>;
@@ -64,6 +75,9 @@ export declare class DescriptionService implements IDescriptionService, IDisposa
     getSearchListByName(searchText: string): ISearchItem[];
     getSearchListByNameFirstLetter(searchText: string): ISearchItem[];
     getSearchListByType(type: number): ISearchItem[];
+    registerDescriptions(description: IFunctionInfo[]): void;
+    unregisterDescriptions(functionNames: string[]): void;
     private _initialize;
-    private _registerDescription;
+    private _initDescription;
+    private _registerDescriptions;
 }

package/lib/types/services/formula-custom-function.service.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { Disposable, ICommandService } from '@univerjs/core';
+import type { PrimitiveValueType } from '@univerjs/engine-formula';
+export type IRegisterFunction = (...arg: Array<PrimitiveValueType | PrimitiveValueType[][]>) => PrimitiveValueType | PrimitiveValueType[][];
+export type IRegisterFunctionList = [[IRegisterFunction, string, string?]];
+export interface IFormulaCustomFunctionService {
+    /**
+     * register descriptions
+     * @param functionList
+     */
+    registerFunctions(functionList: IRegisterFunctionList): void;
+    unregisterFunctions(functionList: string[]): void;
+}
+export declare const IFormulaCustomFunctionService: import("@wendellhu/redi").IdentifierDecorator<IFormulaCustomFunctionService>;
+export declare class FormulaCustomFunctionService extends Disposable implements IFormulaCustomFunctionService {
+    private readonly _commandService;
+    constructor(_commandService: ICommandService);
+    registerFunctions(functionList: IRegisterFunctionList): void;
+    unregisterFunctions(functionList: string[]): void;
+}

package/lib/types/services/function-list/compatibility.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_COMPATIBILITY: IFunctionInfo[];

package/lib/types/services/function-list/cube.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_CUBE: IFunctionInfo[];

package/lib/types/services/function-list/database.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_DATABASE: IFunctionInfo[];

package/lib/types/services/function-list/date.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_DATE: IFunctionInfo[];

package/lib/types/services/function-list/engineering.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_ENGINEERING: IFunctionInfo[];

package/lib/types/services/function-list/financial.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_FINANCIAL: IFunctionInfo[];

package/lib/types/services/function-list/information.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_INFORMATION: IFunctionInfo[];

package/lib/types/services/function-list/logical.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_LOGICAL: IFunctionInfo[];

package/lib/types/services/function-list/lookup.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_LOOKUP: IFunctionInfo[];

package/lib/types/services/function-list/text.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_TEXT: IFunctionInfo[];

package/lib/types/services/function-list/web.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { type IFunctionInfo } from '@univerjs/engine-formula';
 export declare const FUNCTION_LIST_WEB: IFunctionInfo[];

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

@@ -0,0 +1,70 @@
+/**
+ * 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 { ILocales } from '@univerjs/core';
+import { Disposable, LocaleService } from '@univerjs/core';
+import type { IFunctionInfo } from '@univerjs/engine-formula';
+import { IFunctionService } from '@univerjs/engine-formula';
+import { IDescriptionService } from './description.service';
+import type { IRegisterFunctionList } from './formula-custom-function.service';
+import { IFormulaCustomFunctionService } from './formula-custom-function.service';
+/**
+ * Register function operation params
+ */
+export interface IRegisterFunctionParams {
+    /**
+     * i18n
+     */
+    locales?: ILocales;
+    /**
+     * function description
+     */
+    description?: IFunctionInfo[];
+    /**
+     * function calculation
+     */
+    calculate: IRegisterFunctionList;
+}
+/**
+ * Unregister function operation params
+ */
+export interface IUnregisterFunctionParams {
+    /**
+     * Remove i18n
+     */
+    localeKeys?: string[];
+    /**
+     * Function name
+     */
+    functionNames: string[];
+}
+export interface IRegisterFunctionService {
+    /**
+     * register descriptions
+     * @param functionList
+     */
+    registerFunctions(params: IRegisterFunctionParams): void;
+    unregisterFunctions(params: IUnregisterFunctionParams): void;
+}
+export declare const IRegisterFunctionService: import("@wendellhu/redi").IdentifierDecorator<IRegisterFunctionService>;
+export declare class RegisterFunctionService extends Disposable implements IRegisterFunctionService {
+    private readonly _localeService;
+    private readonly _descriptionService;
+    private readonly _formulaCustomFunctionService;
+    private readonly _functionService;
+    constructor(_localeService: LocaleService, _descriptionService: IDescriptionService, _formulaCustomFunctionService: IFormulaCustomFunctionService, _functionService: IFunctionService);
+    registerFunctions(params: IRegisterFunctionParams): void;
+    unregisterFunctions(params: IUnregisterFunctionParams): void;
+}