@univerjs/sheets-formula-ui 0.3.0-nightly.202410101606

package/lib/types/services/formula-common.d.ts

@@ -0,0 +1,18 @@
+import { ICellData, Nullable } from '@univerjs/core';
+export declare enum FormulaResultStatus {
+    NOT_REGISTER = 1,
+    SUCCESS = 2,
+    WAIT = 3,
+    ERROR = 4
+}
+export interface IOtherFormulaResult {
+    result?: Nullable<ICellData>[][];
+    status: FormulaResultStatus;
+    formulaId: string;
+    callbacks: Set<(value: Nullable<ICellData>[][]) => void>;
+    extra?: Record<string, any>;
+}
+export interface IFormulaInfo {
+    id: string;
+    text: string;
+}

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

@@ -0,0 +1,160 @@
+import { Direction, IDisposable, IContextService } from '@univerjs/core';
+import { ISearchItem } from '@univerjs/sheets-formula';
+import { Observable } from 'rxjs';
+import { IFunctionInfo, ISequenceNode } from '@univerjs/engine-formula';
+/** If the formula prompt is visible. */
+export declare const FORMULA_PROMPT_ACTIVATED = "FORMULA_PROMPT_ACTIVATED";
+export interface ISearchFunctionOperationParams {
+    /**
+     * show SearchFunction Component or not
+     */
+    visible: boolean;
+    /**
+     * function search text
+     */
+    searchText: string;
+    /**
+     * function list
+     */
+    searchList: ISearchItem[];
+}
+export interface IHelpFunctionOperationParams {
+    /**
+     * show HelpFunction Component or not
+     */
+    visible: boolean;
+    /**
+     * function param index
+     */
+    paramIndex: number;
+    /**
+     * function info
+     */
+    functionInfo: IFunctionInfo;
+}
+export interface INavigateParam {
+    direction: Direction.UP | Direction.DOWN;
+}
+export interface IFormulaPromptService {
+    /**
+     * listen search function open
+     */
+    search$: Observable<ISearchFunctionOperationParams>;
+    /**
+     * open search function
+     */
+    search(param: ISearchFunctionOperationParams): void;
+    /**
+     * listen help function open
+     */
+    help$: Observable<IHelpFunctionOperationParams>;
+    /**
+     * open help function
+     */
+    help(param: IHelpFunctionOperationParams): void;
+    /**
+     * listen navigate shortcut, UP and DOWN
+     */
+    navigate$: Observable<INavigateParam>;
+    /**
+     * set navigate shortcut
+     */
+    navigate(param: INavigateParam): void;
+    /**
+     * listen accept shortcut, TAB/ENTER
+     */
+    accept$: Observable<boolean>;
+    /**
+     * set accept shortcut
+     */
+    accept(param: boolean): void;
+    /**
+     * accept formula name
+     */
+    acceptFormulaName$: Observable<string>;
+    /**
+     * set accept formula name
+     */
+    acceptFormulaName(param: string): void;
+    isSearching(): boolean;
+    isHelping(): boolean;
+    dispose(): void;
+    getSequenceNodes(): Array<string | ISequenceNode>;
+    setSequenceNodes(nodes: Array<string | ISequenceNode>): void;
+    clearSequenceNodes(): void;
+    getCurrentSequenceNodeIndex(strIndex: number): number;
+    getCurrentSequenceNodeByIndex(nodeIndex: number): string | ISequenceNode;
+    getCurrentSequenceNode(strIndex: number): string | ISequenceNode;
+    updateSequenceRef(nodeIndex: number, refString: string): void;
+    insertSequenceRef(index: number, refString: string): void;
+    insertSequenceString(index: number, content: string): void;
+    enableLockedSelectionChange(): void;
+    disableLockedSelectionChange(): void;
+    isLockedSelectionChange(): boolean;
+    enableLockedSelectionInsert(): void;
+    disableLockedSelectionInsert(): void;
+    isLockedSelectionInsert(): boolean;
+}
+export declare const IFormulaPromptService: import('@wendellhu/redi').IdentifierDecorator<FormulaPromptService>;
+export declare class FormulaPromptService implements IFormulaPromptService, IDisposable {
+    private readonly _contextService;
+    private readonly _search$;
+    private readonly _help$;
+    private readonly _navigate$;
+    private readonly _accept$;
+    private readonly _acceptFormulaName$;
+    readonly search$: Observable<ISearchFunctionOperationParams>;
+    readonly help$: Observable<IHelpFunctionOperationParams>;
+    readonly navigate$: Observable<INavigateParam>;
+    readonly accept$: Observable<boolean>;
+    readonly acceptFormulaName$: Observable<string>;
+    private _searching;
+    private _helping;
+    private _sequenceNodes;
+    private _isLockedOnSelectionChangeRefString;
+    private _isLockedOnSelectionInsertRefString;
+    constructor(_contextService: IContextService);
+    dispose(): void;
+    search(param: ISearchFunctionOperationParams): void;
+    isSearching(): boolean;
+    help(param: IHelpFunctionOperationParams): void;
+    isHelping(): boolean;
+    navigate(param: INavigateParam): void;
+    accept(param: boolean): void;
+    acceptFormulaName(param: string): void;
+    getSequenceNodes(): (string | ISequenceNode)[];
+    setSequenceNodes(nodes: Array<string | ISequenceNode>): void;
+    clearSequenceNodes(): void;
+    getCurrentSequenceNode(strIndex: number): string | ISequenceNode;
+    getCurrentSequenceNodeByIndex(nodeIndex: number): string | ISequenceNode;
+    /**
+     * Query the text coordinates in the sequenceNodes and determine the actual insertion index.
+     * @param strIndex
+     */
+    getCurrentSequenceNodeIndex(strIndex: number): number;
+    /**
+     * Synchronize the reference text based on the changes of the selection.
+     * @param nodeIndex
+     * @param refString
+     */
+    updateSequenceRef(nodeIndex: number, refString: string): void;
+    /**
+     * When the cursor is on the right side of a formula token,
+     * you can add reference text to the formula by drawing a selection.
+     * @param index
+     * @param refString
+     */
+    insertSequenceRef(index: number, refString: string): void;
+    /**
+     * Insert a string at the cursor position in the text corresponding to the sequenceNodes.
+     * @param index
+     * @param content
+     */
+    insertSequenceString(index: number, content: string): void;
+    enableLockedSelectionChange(): void;
+    disableLockedSelectionChange(): void;
+    isLockedSelectionChange(): boolean;
+    enableLockedSelectionInsert(): void;
+    disableLockedSelectionInsert(): void;
+    isLockedSelectionInsert(): boolean;
+}

package/lib/types/services/render-services/ref-selections.render-service.d.ts

@@ -0,0 +1,42 @@
+import { IDisposable, Workbook, Injector, ThemeService } from '@univerjs/core';
+import { IRenderContext, IRenderModule } from '@univerjs/engine-render';
+import { ISelectionWithStyle, SheetsSelectionsService } from '@univerjs/sheets';
+import { BaseSelectionRenderService, SheetSkeletonManagerService } from '@univerjs/sheets-ui';
+import { IShortcutService } from '@univerjs/ui';
+/**
+ * This service extends the existing `SelectionRenderService` to provide the rendering of prompt selections
+ * when user is editing ref ranges in formulas.
+ *
+ * Not that this service works with Uni-mode, which means it should be able to deal with multi render unit
+ * and handle selections on them, though each at a time.
+ *
+ *
+ *
+ */
+export declare class RefSelectionsRenderService extends BaseSelectionRenderService implements IRenderModule {
+    private readonly _context;
+    private readonly _refSelectionsService;
+    private readonly _workbookSelections;
+    private _eventDisposables;
+    constructor(_context: IRenderContext<Workbook>, injector: Injector, themeService: ThemeService, shortcutService: IShortcutService, sheetSkeletonManagerService: SheetSkeletonManagerService, _refSelectionsService: SheetsSelectionsService);
+    getLocation(): [string, string];
+    setRemainLastEnabled(enabled: boolean): void;
+    setSkipLastEnabled(enabled: boolean): void;
+    clearLastSelection(): void;
+    /**
+     * Call this method and user will be able to select on the canvas to update selections.
+     */
+    enableSelectionChanging(): IDisposable;
+    private _disableSelectionChanging;
+    private _initCanvasEventListeners;
+    /**
+     * Update selectionModel in this._workbookSelections by user action in spreadsheet area.
+     */
+    private _initUserActionSyncListener;
+    private _updateSelections;
+    private _initSelectionChangeListener;
+    private _initSkeletonChangeListener;
+    protected _refreshSelectionControl(selectionsData: readonly ISelectionWithStyle[]): void;
+    private _getActiveViewport;
+    private _getSheetObject;
+}

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

@@ -0,0 +1,8 @@
+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/sheets-formula-ui.plugin.d.ts

@@ -0,0 +1,19 @@
+import { IUniverSheetsFormulaBaseConfig } from './controllers/config.schema';
+import { IConfigService, Injector, Plugin, UniverInstanceType } from '@univerjs/core';
+import { IRenderManagerService } from '@univerjs/engine-render';
+/**
+ * The configuration of the formula UI plugin.
+ */
+export declare class UniverSheetsFormulaUIPlugin extends Plugin {
+    private readonly _config;
+    readonly _injector: Injector;
+    private readonly _renderManagerService;
+    private readonly _configService;
+    static pluginName: string;
+    static type: UniverInstanceType;
+    constructor(_config: Partial<IUniverSheetsFormulaBaseConfig> | undefined, _injector: Injector, _renderManagerService: IRenderManagerService, _configService: IConfigService);
+    onStarting(): void;
+    onReady(): void;
+    onRendered(): void;
+    onSteady(): void;
+}

package/lib/types/views/FormulaPromptContainer.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare function RenderFormulaPromptContent(): React.JSX.Element;

package/lib/types/views/more-functions/MoreFunctions.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare function MoreFunctions(): React.JSX.Element;

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

@@ -0,0 +1,22 @@
+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/function-params/FunctionParams.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+interface IParamsProps {
+    className?: string;
+    title?: string | React.ReactElement;
+    value?: string | React.ReactElement;
+}
+export declare function FunctionParams(props: IParamsProps): React.JSX.Element;
+export {};

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

@@ -0,0 +1,7 @@
+import { IFunctionInfo } from '@univerjs/engine-formula';
+import { default as React } from 'react';
+export interface IInputParamsProps {
+    functionInfo: IFunctionInfo | null;
+    onChange: (params: string[]) => void;
+}
+export declare function InputParams(props: IInputParamsProps): React.JSX.Element | null;

package/lib/types/views/more-functions/interface.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 declare const MORE_FUNCTIONS_COMPONENT = "SHEET_FORMULA_UI_PLUGIN_MORE_FUNCTIONS_COMPONENT";

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

@@ -0,0 +1,6 @@
+import { IFunctionInfo } from '@univerjs/engine-formula';
+import { default as React } from 'react';
+export interface ISelectFunctionProps {
+    onChange: (functionInfo: IFunctionInfo) => void;
+}
+export declare function SelectFunction(props: ISelectFunctionProps): React.JSX.Element;

package/lib/types/views/prompt/help-function/HelpFunction.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare function HelpFunction(): React.JSX.Element;

package/lib/types/views/prompt/resize-scroll-observer.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+type Callback = () => void;
+export declare const useResizeScrollObserver: (callback: Callback, delay?: number) => void;
+export default useResizeScrollObserver;

package/lib/types/views/prompt/search-function/SearchFunction.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare function SearchFunction(): false | React.JSX.Element;