@univerjs/sheets 0.21.0 → 0.21.1

package/lib/types/commands/commands/clear-selection-content.command.d.ts

@@ -22,4 +22,4 @@ export interface IClearSelectionContentCommandParams {
 /**
  * The command to clear content in current selected ranges.
  */
-export declare const ClearSelectionContentCommand: ICommand;
+export declare const ClearSelectionContentCommand: ICommand<IClearSelectionContentCommandParams>;

package/lib/types/commands/commands/clear-selection-format.command.d.ts

@@ -22,4 +22,4 @@ export interface IClearSelectionFormatCommandParams {
 /**
  * The command to clear content in current selected ranges.
  */
-export declare const ClearSelectionFormatCommand: ICommand;
+export declare const ClearSelectionFormatCommand: ICommand<IClearSelectionFormatCommandParams>;

package/lib/types/commands/commands/set-defined-name.command.d.ts

@@ -15,10 +15,8 @@
  */
 import type { ICommand } from '@univerjs/core';
 /**
- * The command to update defined name
- *
+ * The command to update defined name.
  * 1. The old defined name can be obtained through IDefinedNamesService, and does not need to be passed in from the outside, making the command input more concise
-
-   2. Unlike InsertDefinedNameCommand, the old defined name needs to be deleted here at the same time. Because the command interception in UpdateDefinedNameController will add SetDefinedNameMutation or RemoveDefinedNameMutation, it results in that in DefinedNameController, only mutations can be listened to to update Function Description (commands cannot be listened to), so it is necessary to ensure that each mutation triggered by the command has completed all work.
+ * 2. Unlike InsertDefinedNameCommand, the old defined name needs to be deleted here at the same time. Because the command interception in UpdateDefinedNameController will add SetDefinedNameMutation or RemoveDefinedNameMutation, it results in that in DefinedNameController, only mutations can be listened to to update Function Description (commands cannot be listened to), so it is necessary to ensure that each mutation triggered by the command has completed all work.
  */
 export declare const SetDefinedNameCommand: ICommand;

package/lib/types/facade/f-defined-name.d.ts

@@ -23,8 +23,10 @@ import { RangeProtectionRuleModel, WorksheetProtectionPointModel, WorksheetProte
  * @hideconstructor
  */
 export declare class FDefinedNameBuilder {
+    protected readonly unitId: string;
+    protected readonly _injector: Injector;
     private _definedNameParam;
-    constructor();
+    constructor(unitId: string, _injector: Injector);
     /**
      * Sets the name of the defined name builder.
      * @param {string} name The name of the defined name.
@@ -32,11 +34,11 @@ export declare class FDefinedNameBuilder {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const definedNameBuilder = univerAPI.newDefinedName()
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
      *   .setName('MyDefinedName')
      *   .setRef('Sheet1!$A$1')
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     setName(name: string): FDefinedNameBuilder;
@@ -47,11 +49,11 @@ export declare class FDefinedNameBuilder {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const definedNameBuilder = univerAPI.newDefinedName()
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
      *   .setName('MyDefinedName')
      *   .setFormula('SUM(Sheet1!$A$1)')
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     setFormula(formula: string): FDefinedNameBuilder;
@@ -62,11 +64,11 @@ export declare class FDefinedNameBuilder {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const definedNameBuilder = univerAPI.newDefinedName()
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
      *   .setName('MyDefinedName')
      *   .setRef('Sheet1!$A$1')
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     setRef(a1Notation: string): FDefinedNameBuilder;
@@ -80,11 +82,11 @@ export declare class FDefinedNameBuilder {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const definedNameBuilder = univerAPI.newDefinedName()
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
      *   .setName('MyDefinedName')
      *   .setRefByRange(1, 3, 2, 5) // D2:H3
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     setRefByRange(row: number, column: number, numRows: number, numColumns: number): FDefinedNameBuilder;
@@ -95,12 +97,12 @@ export declare class FDefinedNameBuilder {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const definedNameBuilder = univerAPI.newDefinedName()
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
      *   .setName('MyDefinedName')
      *   .setRef('Sheet1!$A$1')
      *   .setComment('A reference to A1 cell in Sheet1')
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     setComment(comment: string): FDefinedNameBuilder;
@@ -114,12 +116,12 @@ export declare class FDefinedNameBuilder {
      * const sheets = fWorkbook.getSheets();
      *
      * // Create a defined name and make it available only in the second worksheet
-     * const definedNameBuilder = univerAPI.newDefinedName()
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
      *   .setName('MyDefinedName')
      *   .setRef('Sheet1!$A$1')
      *   .setScopeToWorksheet(sheets[1])
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     setScopeToWorksheet(worksheet: FWorksheet): FDefinedNameBuilder;
@@ -131,12 +133,12 @@ export declare class FDefinedNameBuilder {
      * const fWorkbook = univerAPI.getActiveWorkbook();
      *
      * // Create a defined name and make it available in the entire workbook
-     * const definedNameBuilder = univerAPI.newDefinedName()
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
      *   .setName('MyDefinedName')
      *   .setRef('Sheet1!$A$1')
      *   .setScopeToWorkbook()
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     setScopeToWorkbook(): FDefinedNameBuilder;
@@ -147,12 +149,12 @@ export declare class FDefinedNameBuilder {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const definedNameBuilder = univerAPI.newDefinedName()
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
      *   .setName('MyDefinedName')
      *   .setRef('Sheet1!$A$1')
      *   .setHidden(true)
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     setHidden(hidden: boolean): FDefinedNameBuilder;
@@ -162,12 +164,12 @@ export declare class FDefinedNameBuilder {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const definedNameBuilder = univerAPI.newDefinedName()
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
      *   .setName('MyDefinedName')
      *   .setRef('Sheet1!$A$1')
      *   .setComment('A reference to A1 cell in Sheet1')
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     build(): ISetDefinedNameMutationParam;
@@ -178,16 +180,14 @@ export declare class FDefinedNameBuilder {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const definedNameParam = {
-     *   id: '4TMPceoqg8',
-     *   unitId: fWorkbook.getId(),
-     *   name: 'MyDefinedName',
-     *   formulaOrRefString: 'Sheet1!$A$1',
-     * }
-     * const definedNameBuilder = univerAPI.newDefinedName()
-     *   .load(definedNameParam)
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
+     *   .load({
+     *     id: '4TMPceoqg8',
+     *     name: 'MyDefinedName',
+     *     formulaOrRefString: 'Sheet1!$A$1',
+     *   })
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     load(param: ISetDefinedNameMutationParam): FDefinedNameBuilder;
@@ -374,12 +374,12 @@ export declare class FDefinedName extends FBase {
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const definedName = fWorkbook.getDefinedNames()[0];
      * if (!definedName) return;
-     * const definedNameBuilder = definedName
+     * const definedNameParam = definedName
      *   .toBuilder()
      *   .setName('NewDefinedName')
      *   .setFormula('SUM(Sheet1!$A$1)')
      *   .build();
-     * fWorkbook.updateDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.updateDefinedNameBuilder(definedNameParam);
      * ```
      */
     toBuilder(): FDefinedNameBuilder;

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

@@ -16,7 +16,6 @@
 import type { ICommandInfo, ICreateUnitOptions, IDisposable, Injector, IWorkbookData, Nullable } from '@univerjs/core';
 import type { FWorksheet } from './f-worksheet';
 import { FUniver } from '@univerjs/core/facade';
-import { FDefinedNameBuilder } from './f-defined-name';
 import { FWorkbook } from './f-workbook';
 /**
  * @ignore
@@ -78,21 +77,6 @@ export interface IFUniverSheetsMixin {
      * @deprecated Use `univerAPI.addEvent(univerAPI.Event.UnitCreated, () => {})`
      */
     onUniverSheetCreated(callback: (workbook: FWorkbook) => void): IDisposable;
-    /**
-     * Create a new defined name builder.
-     * @returns {FDefinedNameBuilder} - The defined name builder.
-     * @example
-     * ```ts
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const definedNameBuilder = univerAPI.newDefinedName()
-     *   .setRef('Sheet1!$A$1')
-     *   .setName('MyDefinedName')
-     *   .setComment('This is a comment');
-     * console.log(definedNameBuilder);
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder.build());
-     * ```
-     */
-    newDefinedName(): FDefinedNameBuilder;
     /**
      * Get the target of the sheet.
      * @param {string} unitId - The unitId of the sheet.
@@ -178,7 +162,6 @@ export declare class FUniverSheetsMixin extends FUniver implements IFUniverSheet
     getUniverSheet(id: string): FWorkbook | null;
     getWorkbook(id: string): FWorkbook | null;
     onUniverSheetCreated(callback: (workbook: FWorkbook) => void): IDisposable;
-    newDefinedName(): FDefinedNameBuilder;
     getActiveSheet(): Nullable<{
         workbook: FWorkbook;
         worksheet: FWorksheet;

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

@@ -21,7 +21,7 @@ import { ICommandService, ILogService, Injector, IPermissionService, IResourceLo
 import { FBaseInitialable } from '@univerjs/core/facade';
 import { IDefinedNamesService } from '@univerjs/engine-formula';
 import { RangeThemeStyle, SheetsSelectionsService } from '@univerjs/sheets';
-import { FDefinedName } from './f-defined-name';
+import { FDefinedName, FDefinedNameBuilder } from './f-defined-name';
 import { FRange } from './f-range';
 import { FWorksheet } from './f-worksheet';
 import { FWorkbookPermission } from './permission/f-workbook-permission';
@@ -549,10 +549,6 @@ export declare class FWorkbook extends FBaseInitialable {
      * const fWorkbook = univerAPI.getActiveWorkbook();
      * const definedName = fWorkbook.getDefinedName('MyDefinedName');
      * console.log(definedName?.getFormulaOrRefString());
-     *
-     * if (definedName) {
-     *   definedName.setName('NewDefinedName');
-     * }
      * ```
      */
     getDefinedName(name: string): FDefinedName | null;
@@ -569,30 +565,21 @@ export declare class FWorkbook extends FBaseInitialable {
      */
     getDefinedNames(): FDefinedName[];
     /**
-     * Insert a defined name.
-     * @param {string} name The name of the defined name to insert
-     * @param {string} formulaOrRefString The formula(=sum(A2:b10)) or reference(A1) string of the defined name to insert
-     * @returns {FWorkbook} The current FWorkbook instance
+     * Create a new defined name builder.
+     * @returns {FDefinedNameBuilder} - The defined name builder.
      * @example
      * ```ts
-     * // The code below inserts a defined name
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * fWorkbook.insertDefinedName('MyDefinedName', 'Sheet1!$A$1');
-     * ```
-     */
-    insertDefinedName(name: string, formulaOrRefString: string): FWorkbook;
-    /**
-     * Delete the defined name with the given name.
-     * @param {string} name The name of the defined name to delete
-     * @returns {boolean} true if the defined name was deleted, false otherwise
-     * @example
-     * ```ts
-     * // The code below deletes the defined name with the given name
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * fWorkbook.deleteDefinedName('MyDefinedName');
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
+     *   .setRef('Sheet1!$A$1')
+     *   .setName('MyDefinedName')
+     *   .setComment('This is a comment');
+     *   .build();
+     * console.log(definedNameParam);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
-    deleteDefinedName(name: string): boolean;
+    newDefinedNameBuilder(): FDefinedNameBuilder;
     /**
      * Insert a defined name by builder param.
      * @param {ISetDefinedNameMutationParam} param The param to insert the defined name
@@ -601,12 +588,12 @@ export declare class FWorkbook extends FBaseInitialable {
      * ```ts
      * // The code below inserts a defined name by builder param
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const definedNameBuilder = univerAPI.newDefinedName()
+     * const definedNameParam = fWorkbook.newDefinedNameBuilder()
      *   .setRef('Sheet1!$A$1')
      *   .setName('MyDefinedName')
      *   .setComment('This is a comment')
      *   .build();
-     * fWorkbook.insertDefinedNameBuilder(definedNameBuilder);
+     * fWorkbook.insertDefinedNameBuilder(definedNameParam);
      * ```
      */
     insertDefinedNameBuilder(param: ISetDefinedNameMutationParam): void;
@@ -632,6 +619,31 @@ export declare class FWorkbook extends FBaseInitialable {
      * ```
      */
     updateDefinedNameBuilder(param: ISetDefinedNameMutationParam): void;
+    /**
+     * Insert a defined name.
+     * @param {string} name The name of the defined name to insert
+     * @param {string} formulaOrRefString The formula(=sum(A2:b10)) or reference(A1) string of the defined name to insert
+     * @returns {FWorkbook} The current FWorkbook instance
+     * @example
+     * ```ts
+     * // The code below inserts a defined name
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * fWorkbook.insertDefinedName('MyDefinedName', 'Sheet1!$A$1');
+     * ```
+     */
+    insertDefinedName(name: string, formulaOrRefString: string): FWorkbook;
+    /**
+     * Delete the defined name with the given name.
+     * @param {string} name The name of the defined name to delete
+     * @returns {boolean} true if the defined name was deleted, false otherwise
+     * @example
+     * ```ts
+     * // The code below deletes the defined name with the given name
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * fWorkbook.deleteDefinedName('MyDefinedName');
+     * ```
+     */
+    deleteDefinedName(name: string): boolean;
     /**
      * Gets the registered range themes.
      * @returns {string[]} The name list of registered range themes.

package/lib/types/facade/permission/f-range-protection-rule.d.ts

@@ -32,11 +32,11 @@ export declare class FRangeProtectionRule {
     private readonly _ranges;
     private readonly _options;
     private readonly _injector;
-    private readonly _commandService;
     private readonly _permissionService;
     private readonly _authzIoService;
+    private readonly _commandService;
     private readonly _rangeProtectionRuleModel;
-    constructor(_unitId: string, _subUnitId: string, _ruleId: string, _permissionId: string, _ranges: FRange[], _options: IRangeProtectionOptions, _injector: Injector, _commandService: ICommandService, _permissionService: IPermissionService, _authzIoService: IAuthzIoService, _rangeProtectionRuleModel: RangeProtectionRuleModel);
+    constructor(_unitId: string, _subUnitId: string, _ruleId: string, _permissionId: string, _ranges: FRange[], _options: IRangeProtectionOptions, _injector: Injector, _permissionService: IPermissionService, _authzIoService: IAuthzIoService, _commandService: ICommandService, _rangeProtectionRuleModel: RangeProtectionRuleModel);
     /**
      * Get the rule ID.
      */

package/lib/types/index.d.ts

@@ -16,6 +16,7 @@
 export type { ICellOverGridPosition, ISheetOverGridPosition } from './basics/cell-position';
 export { checkCellValueType } from './basics/cell-type';
 export { COMMAND_LISTENER_SKELETON_CHANGE, COMMAND_LISTENER_VALUE_CHANGE, type CommandListenerSkeletonChange, type CommandListenerValueChange, getSkeletonChangedEffectedRange, getValueChangedEffectedRange, SheetSkeletonChangeType, SheetValueChangeType, } from './basics/const/command-listener-const';
+export { validateDefinedName } from './basics/defined-name-utils';
 export { expandToContinuousRange } from './basics/expand-range';
 export { type IAddWorksheetMergeMutationParams, type IDeleteRangeMutationParams, type IDiscreteRange, type IInsertColMutationParams, type IInsertRangeMutationParams, type IInsertRowMutationParams, type IInsertSheetMutationParams, type IRemoveColMutationParams, type IRemoveRowsMutationParams, type IRemoveSheetMutationParams, type IRemoveWorksheetMergeMutationParams, type IWorksheetRangeThemeStyleMutationParams, } from './basics/interfaces';
 export { createTopMatrixFromMatrix, createTopMatrixFromRanges, findAllRectangle, rangeMerge, RangeMergeUtil } from './basics/range-merge';

package/lib/types/services/auto-fill/tools.d.ts

@@ -22,13 +22,11 @@ declare function sectionToChinese(section: number): string;
 declare function numberToChinese(num: number): string;
 declare function isChnNumber(txt?: string): boolean;
 declare function matchExtendNumber(txt?: string): {
-    isExtendNumber: boolean;
-    matchTxt?: undefined;
-    beforeTxt?: undefined;
-    afterTxt?: undefined;
+    isExtendNumber: false;
 } | {
-    isExtendNumber: boolean;
-    matchTxt: number;
+    isExtendNumber: true;
+    rawMatchTxt: string;
+    matchNumber: number;
     beforeTxt: string;
     afterTxt: string;
 };

package/lib/types/skeleton/skeleton.service.d.ts

@@ -29,6 +29,8 @@ export declare class SheetSkeletonService extends Disposable {
     private readonly _univerInstanceService;
     private _sceneMap;
     private _sheetSkeletonParamStore;
+    private _buildSkeleton$;
+    readonly buildSkeleton$: import("rxjs").Observable<SpreadsheetSkeleton>;
     constructor(_injector: Injector, _univerInstanceService: IUniverInstanceService);
     dispose(): void;
     private _disposeByUnitId;
@@ -37,6 +39,7 @@ export declare class SheetSkeletonService extends Disposable {
     private _initSheetsSkeleton;
     private _buildSkeleton;
     setScene(unitId: string, scene: Scene): void;
+    getSkeletonsByUnitId(unitId: string): SpreadsheetSkeleton[];
     getSkeleton(unitId: string, subUnitId: string): Nullable<SpreadsheetSkeleton>;
     getSkeletonParam(unitId: string, subUnitId: string): Nullable<ISheetSkeletonManagerParam>;
     newSkeleton(unitId: string, subUnitId: string, worksheet: Worksheet, styles: Styles): SpreadsheetSkeleton;