@univerjs/sheets 0.25.1 → 1.0.0-alpha.1

package/lib/types/commands/commands/add-range-protection.command.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { ICommand } from '@univerjs/core';
-import type { IRangeProtectionRule } from '../../model/range-protection-rule.model';
+import type { IRangeProtectionRule } from '../../models/range-protection-rule.model';
 export interface IAddRangeProtectionCommandParams {
     permissionId: string;
     rule: IRangeProtectionRule;

package/lib/types/commands/commands/delete-range-protection.command.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { ICommand } from '@univerjs/core';
-import type { IRangeProtectionRule } from '../../model/range-protection-rule.model';
+import type { IRangeProtectionRule } from '../../models/range-protection-rule.model';
 export interface IDeleteRangeProtectionCommandParams {
     unitId: string;
     subUnitId: string;

package/lib/types/commands/commands/register-range-theme.command.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { ICommand } from '@univerjs/core';
-import type { RangeThemeStyle } from '../../model/range-theme-util';
+import type { RangeThemeStyle } from '../../models/range-theme-util';
 export interface IRegisterWorksheetRangeThemeStyleCommandParams {
     unitId: string;
     rangeThemeStyle: RangeThemeStyle;

package/lib/types/commands/commands/set-protection.command.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { ICommand, IRange } from '@univerjs/core';
-import type { IRangeProtectionRule } from '../../model/range-protection-rule.model';
+import type { IRangeProtectionRule } from '../../models/range-protection-rule.model';
 import type { IWorksheetProtectionRule } from '../../services/permission/type';
 type IPermissionRule = (IRangeProtectionRule | IWorksheetProtectionRule) & {
     ranges: IRange[];

package/lib/types/commands/mutations/add-range-protection.mutation.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { IMutation, IMutationInfo } from '@univerjs/core';
-import type { IRangeProtectionRule } from '../../model/range-protection-rule.model';
+import type { IRangeProtectionRule } from '../../models/range-protection-rule.model';
 import type { IDeleteRangeProtectionMutationParams } from './delete-range-protection.mutation';
 export interface IAddRangeProtectionMutationParams {
     rules: IRangeProtectionRule[];

package/lib/types/commands/mutations/add-range-theme.mutation.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { IMutation } from '@univerjs/core';
-import type { IRangeThemeStyleJSON } from '../../model/range-theme-util';
+import type { IRangeThemeStyleJSON } from '../../models/range-theme-util';
 export interface IAddRangeThemeMutationParams {
     styleJSON: IRangeThemeStyleJSON;
     unitId: string;

package/lib/types/commands/mutations/register-range-theme.mutation.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { IMutation } from '@univerjs/core';
-import type { IRangeThemeStyleJSON } from '../../model/range-theme-util';
+import type { IRangeThemeStyleJSON } from '../../models/range-theme-util';
 export interface IRegisterWorksheetRangeThemeStyleMutationParams {
     unitId: string;
     themeName: string;

package/lib/types/commands/mutations/set-range-protection.mutation.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { IAccessor, IMutation, IMutationInfo } from '@univerjs/core';
-import type { IRangeProtectionRule } from '../../model/range-protection-rule.model';
+import type { IRangeProtectionRule } from '../../models/range-protection-rule.model';
 export interface ISetRangeProtectionMutationParams {
     rule: IRangeProtectionRule;
     unitId: string;

package/lib/types/commands/mutations/set-range-theme.mutation.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { IMutation } from '@univerjs/core';
-import type { IRangeThemeStyleJSON } from '../../model/range-theme-util';
+import type { IRangeThemeStyleJSON } from '../../models/range-theme-util';
 export interface ISetRangeThemeMutationParams {
     unitId: string;
     subUnitId: string;

package/lib/types/commands/mutations/set-range-values.mutation.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IAccessor, ICellData, ICopyToOptionsData, IMutation, IMutationCommonParams, IObjectMatrixPrimitiveType, IRange, Nullable } from '@univerjs/core';
+import type { IAccessor, ICellData, IMutation, IMutationCommonParams, IObjectMatrixPrimitiveType, IRange, Nullable } from '@univerjs/core';
 /** Params of `SetRangeValuesMutation` */
 export interface ISetRangeValuesMutationParams extends IMutationCommonParams {
     subUnitId: string;
@@ -23,9 +23,10 @@ export interface ISetRangeValuesMutationParams extends IMutationCommonParams {
      */
     cellValue?: IObjectMatrixPrimitiveType<Nullable<ICellData>>;
     /**
-     * @deprecated not a good design
+     * Whether to override the style of the cell, used for paste related operations.
+     * @default false
      */
-    options?: ICopyToOptionsData;
+    isOverrideStyle?: boolean;
 }
 export interface ISetRangeValuesRangeMutationParams extends ISetRangeValuesMutationParams {
     range: IRange[];

package/lib/types/controllers/permission/sheet-permission-check.controller.d.ts

@@ -16,7 +16,7 @@
 import type { IPermissionTypes, IRange } from '@univerjs/core';
 import { Disposable, DisposableCollection, ICommandService, IPermissionService, IUniverInstanceService, LocaleService } from '@univerjs/core';
 import { IDefinedNamesService, LexerTreeBuilder } from '@univerjs/engine-formula';
-import { RangeProtectionRuleModel } from '../../model/range-protection-rule.model';
+import { RangeProtectionRuleModel } from '../../models/range-protection-rule.model';
 import { WorksheetProtectionRuleModel } from '../../services/permission/worksheet-permission';
 import { SheetsSelectionsService } from '../../services/selections';
 export declare class SheetPermissionCheckController extends Disposable {

package/lib/types/controllers/permission/sheet-permission-init.controller.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { Disposable, IAuthzIoService, ICommandService, IPermissionService, IUndoRedoService, IUniverInstanceService, UserManagerService } from '@univerjs/core';
-import { RangeProtectionRuleModel } from '../../model/range-protection-rule.model';
+import { RangeProtectionRuleModel } from '../../models/range-protection-rule.model';
 import { WorkbookPermissionService } from '../../services/permission/workbook-permission/workbook-permission.service';
 import { WorksheetProtectionPointModel, WorksheetProtectionRuleModel } from '../../services/permission/worksheet-permission';
 export declare class SheetPermissionInitController extends Disposable {

package/lib/types/controllers/permission/sheet-permission-view-model.controller.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { Disposable, IPermissionService } from '@univerjs/core';
-import { RangeProtectionCache } from '../../model/range-protection.cache';
+import { RangeProtectionCache } from '../../models/range-protection.cache';
 import { WorksheetProtectionRuleModel } from '../../services/permission/worksheet-permission';
 import { SheetInterceptorService } from '../../services/sheet-interceptor/sheet-interceptor.service';
 export declare class SheetPermissionViewModelController extends Disposable {

package/lib/types/controllers/zebar-crossing.controller.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { Disposable, ICommandService, IUniverInstanceService } from '@univerjs/core';
-import { SheetRangeThemeModel } from '../model/range-theme-model';
+import { SheetRangeThemeModel } from '../models/range-theme-model';
 export declare class ZebraCrossingCacheController extends Disposable {
     private readonly _commandService;
     private readonly _sheetRangeThemeModel;

package/lib/types/facade/{f-sheet-hooks.d.ts → const.d.ts}

@@ -13,12 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Injector } from '@univerjs/core';
-import { FBase } from '@univerjs/core/facade';
-/**
- * @hideconstructor
- */
-export declare class FSheetHooks extends FBase {
-    protected readonly _injector: Injector;
-    constructor(_injector: Injector);
-}
+export declare const SHEETS_CUSTOM_FIELD_WARNING_MESSAGE = "[Facade]: The sheets custom field is not recommended for external use. Use it at your own risk.";

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

@@ -17,7 +17,7 @@ import type { AbsoluteRefType, BorderStyleTypes, BorderType, CellValue, CustomDa
 import type { AUTO_FILL_APPLY_TYPE, IMergeCellsUtilOptions, SplitDelimiterEnum } from '@univerjs/sheets';
 import type { IFacadeClearOptions } from './f-worksheet';
 import type { FHorizontalAlignment, FVerticalAlignment } from './utils';
-import { Dimension, ICommandService, Injector, RichTextValue, TextStyleValue, WrapStrategy } from '@univerjs/core';
+import { Dimension, ICommandService, ILogService, Injector, RichTextValue, TextStyleValue, WrapStrategy } from '@univerjs/core';
 import { FBaseInitialable } from '@univerjs/core/facade';
 import { FormulaDataModel } from '@univerjs/engine-formula';
 import { FRangePermission } from './permission/f-range-permission';
@@ -45,7 +45,8 @@ export declare class FRange extends FBaseInitialable {
     protected readonly _injector: Injector;
     protected readonly _commandService: ICommandService;
     protected readonly _formulaDataModel: FormulaDataModel;
-    constructor(_workbook: Workbook, _worksheet: Worksheet, _range: IRange, _injector: Injector, _commandService: ICommandService, _formulaDataModel: FormulaDataModel);
+    protected readonly _logService: ILogService;
+    constructor(_workbook: Workbook, _worksheet: Worksheet, _range: IRange, _injector: Injector, _commandService: ICommandService, _formulaDataModel: FormulaDataModel, _logService: ILogService);
     /**
      * Get the unit ID of the current workbook
      * @returns {string} The unit ID of the workbook

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

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { ICommandInfo, ICreateUnitOptions, IDisposable, Injector, IWorkbookData, Nullable } from '@univerjs/core';
+import type { ICreateUnitOptions, Injector, IWorkbookData } from '@univerjs/core';
 import type { FWorksheet } from './f-worksheet';
 import { FUniver } from '@univerjs/core/facade';
 import { FWorkbook } from './f-workbook';
@@ -21,31 +21,27 @@ import { FWorkbook } from './f-workbook';
  * @ignore
  */
 export interface IFUniverSheetsMixin {
-    /**
-     * @deprecated use `univerAPI.createWorkbook` instead.
-     */
-    createUniverSheet(data: Partial<IWorkbookData>): FWorkbook;
     /**
      * Create a new spreadsheet and get the API handler of that spreadsheet.
      * @param {Partial<IWorkbookData>} data The snapshot of the spreadsheet.
      * @param {ICreateUnitOptions} options The options of creating the spreadsheet.
-     * @returns {FWorkbook} FWorkbook API instance.
+     * @returns {FWorkbook} The spreadsheet API instance.
      * @example
      * ```ts
-     * const fWorkbook = univerAPI.createWorkbook({ id: 'Sheet1', name: 'Sheet1' });
+     * const fWorkbook = univerAPI.createWorkbook({ id: 'workbook-01', name: 'Workbook1' });
      * console.log(fWorkbook);
      * ```
      *
      * Add you can make the workbook not as the active workbook by setting options:
      * ```ts
-     * const fWorkbook = univerAPI.createWorkbook({ id: 'Sheet1', name: 'Sheet1' }, { makeCurrent: false });
+     * const fWorkbook = univerAPI.createWorkbook({ id: 'workbook-01', name: 'Workbook1' }, { makeCurrent: false });
      * console.log(fWorkbook);
      * ```
      */
     createWorkbook(data: Partial<IWorkbookData>, options?: ICreateUnitOptions): FWorkbook;
     /**
      * Get the currently focused Univer spreadsheet.
-     * @returns {FWorkbook | null} The currently focused Univer spreadsheet.
+     * @returns {FWorkbook | null} The currently focused Univer spreadsheet API instance, or null if there is no active spreadsheet.
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -53,49 +49,18 @@ export interface IFUniverSheetsMixin {
      * ```
      */
     getActiveWorkbook(): FWorkbook | null;
-    /**
-     * @deprecated use `univerAPI.getActiveWorkbook` instead
-     */
-    getActiveUniverSheet(): FWorkbook | null;
     /**
      * Get the spreadsheet API handler by the spreadsheet id.
      * @param {string} id The spreadsheet id.
-     * @returns {FWorkbook | null} The spreadsheet API instance.
+     * @returns {FWorkbook | null} The spreadsheet API instance corresponding to the spreadsheet id, or null if not found.
      *
      * @example
      * ```ts
-     * const fWorkbook = univerAPI.getUniverSheet('Sheet1');
-     * console.log(fWorkbook);
-     *
-     * const fWorkbook = univerAPI.getWorkbook('Sheet1');
+     * const fWorkbook = univerAPI.getWorkbook('workbook-01');
      * console.log(fWorkbook);
      * ```
      */
-    getUniverSheet(id: string): FWorkbook | null;
     getWorkbook(id: string): FWorkbook | null;
-    /**
-     * @deprecated Use `univerAPI.addEvent(univerAPI.Event.UnitCreated, () => {})`
-     */
-    onUniverSheetCreated(callback: (workbook: FWorkbook) => void): IDisposable;
-    /**
-     * Get the target of the sheet.
-     * @param {string} unitId - The unitId of the sheet.
-     * @param {string} subUnitId - The subUnitId of the sheet.
-     * @returns {Nullable<{ workbook: FWorkbook; worksheet: FWorksheet }>} - The target of the sheet.
-     * @example
-     * ```ts
-     * const unitId = 'workbook-01';
-     * const subUnitId = 'sheet-0001';
-     * const target = univerAPI.getSheetTarget(unitId, subUnitId);
-     * if (!target) return;
-     * const { workbook, worksheet } = target;
-     * console.log(workbook, worksheet);
-     * ```
-     */
-    getSheetTarget(unitId: string, subUnitId: string): Nullable<{
-        workbook: FWorkbook;
-        worksheet: FWorksheet;
-    }>;
     /**
      * Get the target of the sheet.
      * @param {ICommandInfo<object>} commandInfo - The commandInfo of the command.
@@ -104,17 +69,23 @@ export interface IFUniverSheetsMixin {
      * ```ts
      * univerAPI.addEvent(univerAPI.Event.CommandExecuted, (event) => {
      *   const { options, ...commandInfo } = event;
-     *   const target = univerAPI.getCommandSheetTarget(commandInfo);
+     *   const target = univerAPI.getSheetCommandTarget(commandInfo.params);
      *   if (!target) return;
      *   const { workbook, worksheet } = target;
      *   console.log(workbook, worksheet);
      * });
      * ```
      */
-    getCommandSheetTarget(commandInfo: ICommandInfo<object>): Nullable<{
+    getSheetCommandTarget(params?: {
+        unitId?: string;
+        subUnitId?: string;
+        sheetId?: string;
+    }): {
         workbook: FWorkbook;
         worksheet: FWorksheet;
-    }>;
+        unitId: string;
+        subUnitId: string;
+    } | null;
     /**
      * Get the active sheet.
      * @returns {Nullable<{ workbook: FWorkbook; worksheet: FWorksheet }>} The active sheet.
@@ -126,10 +97,10 @@ export interface IFUniverSheetsMixin {
      * console.log(workbook, worksheet);
      * ```
      */
-    getActiveSheet(): Nullable<{
+    getActiveSheet(): {
         workbook: FWorkbook;
         worksheet: FWorksheet;
-    }>;
+    } | null;
     /**
      * Set whether to enable synchronize the frozen state to other users in real-time collaboration.
      * @param {boolean} enabled - Whether to enable freeze sync. Default is true.
@@ -142,31 +113,29 @@ export interface IFUniverSheetsMixin {
     setFreezeSync(enabled: boolean): void;
 }
 export declare class FUniverSheetsMixin extends FUniver implements IFUniverSheetsMixin {
-    getCommandSheetTarget(commandInfo: ICommandInfo<object>): Nullable<{
+    createWorkbook(data: Partial<IWorkbookData>, options?: ICreateUnitOptions): FWorkbook;
+    getActiveWorkbook(): FWorkbook | null;
+    getWorkbook(id: string): FWorkbook | null;
+    getSheetCommandTarget(params?: {
+        unitId?: string;
+        subUnitId?: string;
+        sheetId?: string;
+    }): {
         workbook: FWorkbook;
         worksheet: FWorksheet;
-    }>;
-    getSheetTarget(unitId: string, subUnitId: string): Nullable<{
+        unitId: string;
+        subUnitId: string;
+    } | null;
+    getActiveSheet(): {
         workbook: FWorkbook;
         worksheet: FWorksheet;
-    }>;
-    private _initWorkbookEvent;
+    } | null;
+    setFreezeSync(enabled: boolean): void;
     /**
      * @ignore
      */
     _initialize(injector: Injector): void;
-    createUniverSheet(data: Partial<IWorkbookData>, options?: ICreateUnitOptions): FWorkbook;
-    createWorkbook(data: Partial<IWorkbookData>, options?: ICreateUnitOptions): FWorkbook;
-    getActiveWorkbook(): FWorkbook | null;
-    getActiveUniverSheet(): FWorkbook | null;
-    getUniverSheet(id: string): FWorkbook | null;
-    getWorkbook(id: string): FWorkbook | null;
-    onUniverSheetCreated(callback: (workbook: FWorkbook) => void): IDisposable;
-    getActiveSheet(): Nullable<{
-        workbook: FWorkbook;
-        worksheet: FWorksheet;
-    }>;
-    setFreezeSync(enabled: boolean): void;
+    private _initWorkbookEvent;
 }
 declare module '@univerjs/core/facade' {
     interface FUniver extends IFUniverSheetsMixin {

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

@@ -13,11 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { CommandListener, CustomData, IDisposable, IRange, IStyleData, IWorkbookData, IWorksheetData, LocaleType, Workbook } from '@univerjs/core';
+import type { CommandListener, CustomData, IDisposable, IRange, IStyleData, IWorkbookData, IWorksheetData, Workbook } from '@univerjs/core';
 import type { ISetDefinedNameMutationParam } from '@univerjs/engine-formula';
 import type { IRangeThemeStyleJSON } from '@univerjs/sheets';
 import type { FontLine as _FontLine } from './f-range';
-import { ICommandService, ILogService, Injector, IPermissionService, IResourceLoaderService, IUniverInstanceService, LocaleService } from '@univerjs/core';
+import { ICommandService, ILogService, Injector, IPermissionService, IResourceLoaderService, IUniverInstanceService } from '@univerjs/core';
 import { FBaseInitialable } from '@univerjs/core/facade';
 import { IDefinedNamesService } from '@univerjs/engine-formula';
 import { RangeThemeStyle, SheetsSelectionsService } from '@univerjs/sheets';
@@ -38,10 +38,9 @@ export declare class FWorkbook extends FBaseInitialable {
     protected readonly _commandService: ICommandService;
     protected readonly _permissionService: IPermissionService;
     protected readonly _logService: ILogService;
-    protected readonly _localeService: LocaleService;
     protected readonly _definedNamesService: IDefinedNamesService;
     readonly id: string;
-    constructor(_workbook: Workbook, _injector: Injector, _resourceLoaderService: IResourceLoaderService, _selectionManagerService: SheetsSelectionsService, _univerInstanceService: IUniverInstanceService, _commandService: ICommandService, _permissionService: IPermissionService, _logService: ILogService, _localeService: LocaleService, _definedNamesService: IDefinedNamesService);
+    constructor(_workbook: Workbook, _injector: Injector, _resourceLoaderService: IResourceLoaderService, _selectionManagerService: SheetsSelectionsService, _univerInstanceService: IUniverInstanceService, _commandService: ICommandService, _permissionService: IPermissionService, _logService: ILogService, _definedNamesService: IDefinedNamesService);
     /**
      * Get the Workbook instance.
      * @returns {Workbook} The Workbook instance.
@@ -102,18 +101,6 @@ export declare class FWorkbook extends FBaseInitialable {
      * ```
      */
     save(): IWorkbookData;
-    /**
-     * @deprecated use 'save' instead.
-     * @returns {IWorkbookData} Workbook snapshot data
-     * @memberof FWorkbook
-     * @example
-     * ```ts
-     * // The code below saves the workbook snapshot data
-     * const activeSpreadsheet = univerAPI.getActiveWorkbook();
-     * const snapshot = activeSpreadsheet.getSnapshot();
-     * ```
-     */
-    getSnapshot(): IWorkbookData;
     /**
      * Get the active sheet of the workbook.
      * @returns {FWorksheet} The active sheet of the workbook
@@ -450,35 +437,6 @@ export declare class FWorkbook extends FBaseInitialable {
      * ```
      */
     getNumSheets(): number;
-    /**
-     * Get the locale of the workbook.
-     * @returns {LocaleType} The locale of the workbook
-     * @example
-     * ```ts
-     * // The code below gets the locale of the workbook
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * console.log(fWorkbook.getLocale());
-     * ```
-     */
-    getLocale(): LocaleType;
-    /**
-     * @deprecated use `setSpreadsheetLocale` instead.
-     * @param {LocaleType} locale - The locale to set
-     */
-    setLocale(locale: LocaleType): void;
-    /**
-     * Set the locale of the workbook.
-     * @param {LocaleType} locale The locale to set
-     * @returns {FWorkbook} This workbook, for chaining
-     * @example
-     * ```ts
-     * // The code below sets the locale of the workbook
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * fWorkbook.setSpreadsheetLocale(univerAPI.Enum.LocaleType.EN_US);
-     * console.log(fWorkbook.getLocale());
-     * ```
-     */
-    setSpreadsheetLocale(locale: LocaleType): FWorkbook;
     /**
      * Get the URL of the workbook.
      * @returns {string} The URL of the workbook

package/lib/types/facade/index.d.ts

@@ -19,7 +19,6 @@ export * from './f-enum';
 export * from './f-event';
 export { FRange } from './f-range';
 export { FSelection } from './f-selection';
-export { FSheetHooks } from './f-sheet-hooks';
 export { FWorkbook } from './f-workbook';
 export { FWorksheet } from './f-worksheet';
 export { FWorkbookPermission } from './permission/f-workbook-permission';