@univerjs/sheets-formula 0.1.9 → 0.1.11

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

@@ -9227,6 +9227,21 @@ declare const _default: {
             required: string;
             optional: string;
         };
+        error: {
+            title: string;
+            divByZero: string;
+            name: string;
+            value: string;
+            num: string;
+            na: string;
+            cycle: string;
+            ref: string;
+            spill: string;
+            calc: string;
+            error: string;
+            connect: string;
+            null: string;
+        };
         functionType: {
             financial: string;
             date: string;

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

@@ -1,6 +1,6 @@
-import { IDisposable } from '@wendellhu/redi';
-import { IFunctionInfo, IFunctionNames, IFunctionService } from '@univerjs/engine-formula';
 import { LocaleService } from '@univerjs/core';
+import { IFunctionInfo, IFunctionNames, IFunctionService } from '@univerjs/engine-formula';
+import { IDisposable } from '@wendellhu/redi';
 
 export interface ISearchItem {
     name: string;
@@ -39,7 +39,7 @@ export interface IDescriptionService {
      * register descriptions
      * @param functionList
      */
-    registerDescriptions(functionList: IFunctionInfo[]): void;
+    registerDescriptions(functionList: IFunctionInfo[]): IDisposable;
     /**
      * unregister descriptions
      * @param functionList
@@ -75,7 +75,7 @@ export declare class DescriptionService implements IDescriptionService, IDisposa
     getSearchListByName(searchText: string): ISearchItem[];
     getSearchListByNameFirstLetter(searchText: string): ISearchItem[];
     getSearchListByType(type: number): ISearchItem[];
-    registerDescriptions(description: IFunctionInfo[]): void;
+    registerDescriptions(description: IFunctionInfo[]): IDisposable;
     unregisterDescriptions(functionNames: string[]): void;
     hasDescription(name: string): boolean;
     hasDefinedNameDescription(name: string): boolean;

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

@@ -1,5 +1,6 @@
-import { PrimitiveValueType } from '@univerjs/engine-formula';
 import { Disposable, ICommandService } from '@univerjs/core';
+import { PrimitiveValueType } from '@univerjs/engine-formula';
+import { IDisposable } from '@wendellhu/redi';
 
 export type IRegisterFunction = (...arg: Array<PrimitiveValueType | PrimitiveValueType[][]>) => PrimitiveValueType | PrimitiveValueType[][];
 export type IRegisterFunctionList = [[IRegisterFunction, string, string?]];
@@ -8,13 +9,11 @@ export interface IFormulaCustomFunctionService {
      * register descriptions
      * @param functionList
      */
-    registerFunctions(functionList: IRegisterFunctionList): void;
-    unregisterFunctions(functionList: string[]): void;
+    registerFunctions(functionList: IRegisterFunctionList): IDisposable;
 }
 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;
+    registerFunctions(functionList: IRegisterFunctionList): IDisposable;
 }

package/lib/types/services/formula-ref-range.service.d.ts

@@ -1,7 +1,7 @@
-import { IDisposable } from '@wendellhu/redi';
-import { RefRangeService } from '@univerjs/sheets';
-import { LexerTreeBuilder } from '@univerjs/engine-formula';
 import { IMutationInfo, Disposable, IUniverInstanceService } from '@univerjs/core';
+import { LexerTreeBuilder } from '@univerjs/engine-formula';
+import { RefRangeService } from '@univerjs/sheets';
+import { IDisposable } from '@wendellhu/redi';
 
 export type FormulaChangeMap = Record<string, Record<string, Record<string, string>>>;
 export type FormulaChangeCallback = (formulaString: string) => {

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

@@ -1,8 +1,8 @@
-import { ISearchItem } from './description.service';
-import { Observable } from 'rxjs';
-import { IDisposable } from '@wendellhu/redi';
-import { IFunctionInfo, ISequenceNode } from '@univerjs/engine-formula';
 import { Direction } from '@univerjs/core';
+import { IFunctionInfo, ISequenceNode } from '@univerjs/engine-formula';
+import { IDisposable } from '@wendellhu/redi';
+import { Observable } from 'rxjs';
+import { ISearchItem } from './description.service';
 
 export interface ISearchFunctionOperationParams {
     /**

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

@@ -1,7 +1,8 @@
-import { IRegisterFunctionList, IFormulaCustomFunctionService } from './formula-custom-function.service';
-import { IDescriptionService } from './description.service';
-import { IFunctionInfo, IFunctionService } from '@univerjs/engine-formula';
 import { ILocales, Disposable, LocaleService } from '@univerjs/core';
+import { IFunctionInfo, IFunctionService } from '@univerjs/engine-formula';
+import { IDisposable } from '@wendellhu/redi';
+import { IDescriptionService } from './description.service';
+import { IRegisterFunctionList, IFormulaCustomFunctionService } from './formula-custom-function.service';
 
 /**
  * Register function operation params
@@ -38,8 +39,7 @@ export interface IRegisterFunctionService {
      * register descriptions
      * @param functionList
      */
-    registerFunctions(params: IRegisterFunctionParams): void;
-    unregisterFunctions(params: IUnregisterFunctionParams): void;
+    registerFunctions(params: IRegisterFunctionParams): IDisposable;
 }
 export declare const IRegisterFunctionService: import('@wendellhu/redi').IdentifierDecorator<IRegisterFunctionService>;
 export declare class RegisterFunctionService extends Disposable implements IRegisterFunctionService {
@@ -48,6 +48,5 @@ export declare class RegisterFunctionService extends Disposable implements IRegi
     private readonly _formulaCustomFunctionService;
     private readonly _functionService;
     constructor(_localeService: LocaleService, _descriptionService: IDescriptionService, _formulaCustomFunctionService: IFormulaCustomFunctionService, _functionService: IFunctionService);
-    registerFunctions(params: IRegisterFunctionParams): void;
-    unregisterFunctions(params: IUnregisterFunctionParams): void;
+    registerFunctions(params: IRegisterFunctionParams): IDisposable;
 }

package/lib/types/services/register-other-formula.service.d.ts

@@ -1,6 +1,6 @@
-import { IOtherFormulaResult } from './formula-common';
-import { IActiveDirtyManagerService } from '@univerjs/engine-formula';
 import { Nullable, Disposable, ICommandService } from '@univerjs/core';
+import { IActiveDirtyManagerService } from '@univerjs/engine-formula';
+import { IOtherFormulaResult } from './formula-common';
 
 export declare class RegisterOtherFormulaService extends Disposable {
     private readonly _commandService;

package/lib/types/services/utils.d.ts

@@ -1,8 +1,9 @@
-import { IFunctionInfo } from '@univerjs/engine-formula';
 import { LocaleService } from '@univerjs/core';
+import { IFunctionInfo, IFunctionParam } from '@univerjs/engine-formula';
 
 export declare function getFunctionTypeValues(enumObj: any, localeService: LocaleService): Array<{
     label: string;
     value: string;
 }>;
 export declare function getFunctionName(item: IFunctionInfo, localeService: LocaleService): string;
+export declare function generateParam(param: IFunctionParam): string | undefined;

package/lib/types/views/more-functions/function-help/FunctionHelp.d.ts

@@ -1,9 +1,23 @@
-import { default as React } from 'react';
 import { IFunctionParam } from '@univerjs/engine-formula';
+import { default as React } from 'react';
 
 interface IFunctionHelpProps {
     prefix?: string;
     value?: IFunctionParam[];
 }
+/**
+ * Determine the parameter format
+ * ┌─────────┬────────┬─────────────┐
+ * │ Require │ Repeat │  Parameter  │
+ * ├─────────┼────────┼─────────────┤
+ * │ 0       │ 0      │ [Number]    │
+ * │ 1       │ 0      │ Number      │
+ * │ 0       │ 1      │ [Number,...] │
+ * │ 1       │ 1      │ Number,...   │
+ * └─────────┴────────┴─────────────┘
+ *
+ * @param props
+ * @returns
+ */
 export declare function FunctionHelp(props: IFunctionHelpProps): React.JSX.Element;
 export {};

package/lib/types/views/more-functions/input-params/InputParams.d.ts

@@ -1,5 +1,5 @@
-import { default as React } from 'react';
 import { IFunctionInfo } from '@univerjs/engine-formula';
+import { default as React } from 'react';
 
 export interface IInputParamsProps {
     functionInfo: IFunctionInfo | null;

package/lib/types/views/more-functions/select-function/SelectFunction.d.ts

@@ -1,5 +1,5 @@
-import { default as React } from 'react';
 import { IFunctionInfo } from '@univerjs/engine-formula';
+import { default as React } from 'react';
 
 export interface ISelectFunctionProps {
     onChange: (functionInfo: IFunctionInfo) => void;