refactor: change workbook snapshot fields and names (#483)

* refactor: rename some interfaces to make the semantic correct * chore: remove empty files * fix: remove deprecated properties
dream-num · Nov 18, 2023 · 909efe3 · 909efe3
1 parent ea70bdc
commit 909efe3
Show file tree

Hide file tree

Showing 49 changed files with 128 additions and 309 deletions.
diff --git a/packages/base-render/src/components/sheets/sheet-skeleton.ts b/packages/base-render/src/components/sheets/sheet-skeleton.ts
@@ -20,7 +20,7 @@ import {
     IStyleData,
     ITextRotation,
     ITextStyle,
-    IWorksheetConfig,
+    IWorksheetData,
     LocaleService,
     Nullable,
     ObjectArrayType,
@@ -216,7 +216,7 @@ export class SpreadsheetSkeleton extends Skeleton {
 
     constructor(
         private _worksheet: Worksheet | undefined,
-        private _config: IWorksheetConfig,
+        private _config: IWorksheetData,
         private _cellData: ObjectMatrix<ICellData>,
         private _styles: Styles,
         _localeService: LocaleService
@@ -297,7 +297,7 @@ export class SpreadsheetSkeleton extends Skeleton {
      */
     static create(
         worksheet: Worksheet | undefined,
-        config: IWorksheetConfig,
+        config: IWorksheetData,
         cellData: ObjectMatrix<ICellData>,
         styles: Styles,
         LocaleService: LocaleService

diff --git a/packages/base-sheets/src/basics/interfaces/mutation-interface.ts b/packages/base-sheets/src/basics/interfaces/mutation-interface.ts
@@ -4,7 +4,7 @@ import {
     IColumnData,
     IRange,
     IRowData,
-    IWorksheetConfig,
+    IWorksheetData,
     ObjectArray,
     ObjectMatrixPrimitiveType,
 } from '@univerjs/core';
@@ -18,7 +18,7 @@ export interface IRemoveSheetMutationParams {
 /** Params of `InsertSheetMutation` */
 export interface IInsertSheetMutationParams {
     index: number;
-    sheet: IWorksheetConfig;
+    sheet: IWorksheetData;
     workbookId: string;
 }
 

diff --git a/packages/base-sheets/src/commands/commands/__tests__/create-command-test-bed.ts b/packages/base-sheets/src/commands/commands/__tests__/create-command-test-bed.ts
@@ -1,7 +1,7 @@
 import {
     ILogService,
     IUniverInstanceService,
-    IWorkbookConfig,
+    IWorkbookData,
     LocaleType,
     Plugin,
     PluginType,
@@ -12,7 +12,7 @@ import { Dependency, Inject, Injector } from '@wendellhu/redi';
 import { BorderStyleManagerService } from '../../../services/border-style-manager.service';
 import { SelectionManagerService } from '../../../services/selection-manager.service';
 
-const TEST_WORKBOOK_DATA_DEMO: IWorkbookConfig = {
+const TEST_WORKBOOK_DATA_DEMO: IWorkbookData = {
     id: 'test',
     appVersion: '3.0.0-alpha',
     sheets: {
@@ -30,18 +30,13 @@ const TEST_WORKBOOK_DATA_DEMO: IWorkbookConfig = {
             },
         },
     },
-    createdTime: '',
-    creator: '',
-    lastModifiedBy: '',
     locale: LocaleType.EN_US,
-    modifiedTime: '',
     name: '',
     sheetOrder: [],
     styles: {},
-    timeZone: '',
 };
 
-export function createCommandTestBed(workbookConfig?: IWorkbookConfig, dependencies?: Dependency[]) {
+export function createCommandTestBed(workbookConfig?: IWorkbookData, dependencies?: Dependency[]) {
     const univer = new Univer();
 
     let get: Injector['get'] | undefined;

diff --git a/packages/base-sheets/src/commands/commands/__tests__/delete-range.command.spec.ts b/packages/base-sheets/src/commands/commands/__tests__/delete-range.command.spec.ts
@@ -4,7 +4,7 @@ import {
     IRange,
     IStyleData,
     IUniverInstanceService,
-    IWorkbookConfig,
+    IWorkbookData,
     LocaleType,
     Nullable,
     RANGE_TYPE,
@@ -77,7 +77,7 @@ const mergeData = [
         endColumn: 3,
     },
 ];
-const WORKBOOK_DATA_DEMO: IWorkbookConfig = {
+const WORKBOOK_DATA_DEMO: IWorkbookData = {
     id: 'test',
     appVersion: '3.0.0-alpha',
     sheets: {
@@ -134,15 +134,10 @@ const WORKBOOK_DATA_DEMO: IWorkbookConfig = {
             mergeData,
         },
     },
-    createdTime: '',
-    creator: '',
-    lastModifiedBy: '',
     locale: LocaleType.EN_US,
-    modifiedTime: '',
     name: '',
     sheetOrder: [],
     styles: {},
-    timeZone: '',
 };
 
 describe('Test delete range commands', () => {

diff --git a/packages/base-sheets/src/commands/commands/__tests__/insert-range.command.spec.ts b/packages/base-sheets/src/commands/commands/__tests__/insert-range.command.spec.ts
@@ -4,7 +4,7 @@ import {
     IRange,
     IStyleData,
     IUniverInstanceService,
-    IWorkbookConfig,
+    IWorkbookData,
     LocaleType,
     Nullable,
     RANGE_TYPE,
@@ -79,7 +79,7 @@ const mergeData = [
         endColumn: 3,
     },
 ];
-const WORKBOOK_DATA_DEMO: IWorkbookConfig = {
+const WORKBOOK_DATA_DEMO: IWorkbookData = {
     id: 'test',
     appVersion: '3.0.0-alpha',
     sheets: {
@@ -136,15 +136,10 @@ const WORKBOOK_DATA_DEMO: IWorkbookConfig = {
             mergeData,
         },
     },
-    createdTime: '',
-    creator: '',
-    lastModifiedBy: '',
     locale: LocaleType.EN_US,
-    modifiedTime: '',
     name: '',
     sheetOrder: [],
     styles: {},
-    timeZone: '',
 };
 
 describe('Test insert range commands', () => {

diff --git a/packages/base-sheets/src/commands/commands/__tests__/insert-remove-rows-cols.command.spec.ts b/packages/base-sheets/src/commands/commands/__tests__/insert-remove-rows-cols.command.spec.ts
@@ -5,7 +5,7 @@ import {
     IRange,
     IStyleData,
     IUniverInstanceService,
-    IWorkbookConfig,
+    IWorkbookData,
     LocaleType,
     Nullable,
     RANGE_TYPE,
@@ -313,7 +313,7 @@ describe('Test insert and remove rows cols commands', () => {
     });
 });
 
-const TEST_ROW_COL_INSERTION_DEMO: IWorkbookConfig = {
+const TEST_ROW_COL_INSERTION_DEMO: IWorkbookData = {
     id: 'test',
     appVersion: '3.0.0-alpha',
     sheets: {
@@ -372,15 +372,10 @@ const TEST_ROW_COL_INSERTION_DEMO: IWorkbookConfig = {
             columnCount: 20,
         },
     },
-    createdTime: '',
-    creator: '',
-    lastModifiedBy: '',
     locale: LocaleType.EN_US,
-    modifiedTime: '',
     name: '',
     sheetOrder: [],
     styles: {},
-    timeZone: '',
 };
 
 function createInsertRowColTestBed() {

diff --git a/packages/base-sheets/src/commands/commands/__tests__/move-range-commands.spec.ts b/packages/base-sheets/src/commands/commands/__tests__/move-range-commands.spec.ts
@@ -4,7 +4,7 @@ import {
     ICommandService,
     IRange,
     IUniverInstanceService,
-    IWorkbookConfig,
+    IWorkbookData,
     LocaleType,
     Nullable,
     Rectangle,
@@ -138,7 +138,7 @@ describe('Test move range commands', () => {
     }
 });
 
-const TEST_ROW_COL_INSERTION_DEMO: IWorkbookConfig = {
+const TEST_ROW_COL_INSERTION_DEMO: IWorkbookData = {
     id: 'test',
     appVersion: '3.0.0-alpha',
     sheets: {
@@ -185,15 +185,10 @@ const TEST_ROW_COL_INSERTION_DEMO: IWorkbookConfig = {
             columnCount: 20,
         },
     },
-    createdTime: '',
-    creator: '',
-    lastModifiedBy: '',
     locale: LocaleType.EN_US,
-    modifiedTime: '',
     name: '',
     sheetOrder: [],
     styles: {},
-    timeZone: '',
 };
 
 function createInsertRowColTestBed() {

diff --git a/packages/base-sheets/src/commands/commands/__tests__/move-rows-cols.command.spec.ts b/packages/base-sheets/src/commands/commands/__tests__/move-rows-cols.command.spec.ts
@@ -3,7 +3,7 @@ import {
     ICommandService,
     IRange,
     IUniverInstanceService,
-    IWorkbookConfig,
+    IWorkbookData,
     LocaleType,
     Nullable,
     RANGE_TYPE,
@@ -322,7 +322,7 @@ describe('Test move rows cols', () => {
     });
 });
 
-const TEST_ROWS_COLS_MOVE_DEMO: IWorkbookConfig = {
+const TEST_ROWS_COLS_MOVE_DEMO: IWorkbookData = {
     id: 'test',
     appVersion: '3.0.0-alpha',
     sheets: {
@@ -377,15 +377,10 @@ const TEST_ROWS_COLS_MOVE_DEMO: IWorkbookConfig = {
             columnCount: 20,
         },
     },
-    createdTime: '',
-    creator: '',
-    lastModifiedBy: '',
     locale: LocaleType.EN_US,
-    modifiedTime: '',
     name: '',
     sheetOrder: [],
     styles: {},
-    timeZone: '',
 };
 
 function createMoveRowsColsTestBed() {

diff --git a/packages/base-sheets/src/commands/commands/__tests__/set-frozen.command.spec.ts b/packages/base-sheets/src/commands/commands/__tests__/set-frozen.command.spec.ts
@@ -2,7 +2,7 @@
 import {
     ICommandService,
     IUniverInstanceService,
-    IWorkbookConfig,
+    IWorkbookData,
     LocaleType,
     RedoCommand,
     UndoCommand,
@@ -15,7 +15,7 @@ import { SetFrozenMutation } from '../../mutations/set-frozen.mutation';
 import { SetFrozenCommand } from '../set-frozen.command';
 import { createCommandTestBed } from './create-command-test-bed';
 
-const WORKBOOK_DATA_DEMO: IWorkbookConfig = {
+const WORKBOOK_DATA_DEMO: IWorkbookData = {
     id: 'test',
     appVersion: '3.0.0-alpha',
     sheets: {
@@ -72,15 +72,10 @@ const WORKBOOK_DATA_DEMO: IWorkbookConfig = {
             mergeData: [],
         },
     },
-    createdTime: '',
-    creator: '',
-    lastModifiedBy: '',
     locale: LocaleType.EN_US,
-    modifiedTime: '',
     name: '',
     sheetOrder: [],
     styles: {},
-    timeZone: '',
 };
 
 describe('Test set frozen commands', () => {

diff --git a/packages/base-sheets/src/commands/commands/insert-sheet.command.ts b/packages/base-sheets/src/commands/commands/insert-sheet.command.ts
@@ -5,7 +5,7 @@ import {
     ICommandService,
     IUndoRedoService,
     IUniverInstanceService,
-    IWorksheetConfig,
+    IWorksheetData,
     Tools,
 } from '@univerjs/core';
 import { IAccessor } from '@wendellhu/redi';
@@ -22,7 +22,7 @@ import {
 export interface InsertSheetCommandParams {
     workbookId?: string;
     index?: number;
-    sheet?: IWorksheetConfig;
+    sheet?: IWorksheetData;
 }
 
 /**

diff --git a/packages/base-sheets/src/commands/mutations/set-worksheet-config.mutation.ts b/packages/base-sheets/src/commands/mutations/set-worksheet-config.mutation.ts
@@ -1,11 +1,11 @@
-import { CommandType, IMutation, IUniverInstanceService, IWorksheetConfig, Tools } from '@univerjs/core';
+import { CommandType, IMutation, IUniverInstanceService, IWorksheetData, Tools } from '@univerjs/core';
 import { IAccessor } from '@wendellhu/redi';
 
 /** @deprecated */
 export interface ISetWorksheetConfigMutationParams {
     workbookId: string;
     worksheetId: string;
-    config: IWorksheetConfig;
+    config: IWorksheetData;
 }
 
 /** @deprecated */

diff --git a/packages/base-sheets/src/controllers/__tests__/util.ts b/packages/base-sheets/src/controllers/__tests__/util.ts
@@ -1,15 +1,15 @@
 import {
     ILogService,
     IUniverInstanceService,
-    IWorkbookConfig,
+    IWorkbookData,
     LocaleType,
     Plugin,
     PluginType,
     Univer,
 } from '@univerjs/core';
 import { Dependency, Inject, Injector } from '@wendellhu/redi';
 
-const TEST_WORKBOOK_DATA_DEMO: IWorkbookConfig = {
+const TEST_WORKBOOK_DATA_DEMO: IWorkbookData = {
     id: 'test',
     appVersion: '3.0.0-alpha',
     sheets: {
@@ -27,18 +27,13 @@ const TEST_WORKBOOK_DATA_DEMO: IWorkbookConfig = {
             },
         },
     },
-    createdTime: '',
-    creator: '',
-    lastModifiedBy: '',
     locale: LocaleType.EN_US,
-    modifiedTime: '',
     name: '',
     sheetOrder: [],
     styles: {},
-    timeZone: '',
 };
 
-export function createTestBase(workbookConfig?: IWorkbookConfig, dependencies?: Dependency[]) {
+export function createTestBase(workbookConfig?: IWorkbookData, dependencies?: Dependency[]) {
     const univer = new Univer();
 
     let get: Injector['get'] | undefined;

diff --git a/packages/base-sheets/src/services/__tests__/util.ts b/packages/base-sheets/src/services/__tests__/util.ts
@@ -1,15 +1,15 @@
 import {
     ILogService,
     IUniverInstanceService,
-    IWorkbookConfig,
+    IWorkbookData,
     LocaleType,
     Plugin,
     PluginType,
     Univer,
 } from '@univerjs/core';
 import { Dependency, Inject, Injector } from '@wendellhu/redi';
 
-export const TEST_WORKBOOK_DATA_DEMO: IWorkbookConfig = {
+export const TEST_WORKBOOK_DATA_DEMO: IWorkbookData = {
     id: 'test',
     appVersion: '3.0.0-alpha',
     sheets: {
@@ -27,18 +27,13 @@ export const TEST_WORKBOOK_DATA_DEMO: IWorkbookConfig = {
             },
         },
     },
-    createdTime: '',
-    creator: '',
-    lastModifiedBy: '',
     locale: LocaleType.EN_US,
-    modifiedTime: '',
     name: '',
     sheetOrder: [],
     styles: {},
-    timeZone: '',
 };
 
-export function createTestBase(workbookConfig?: IWorkbookConfig, dependencies?: Dependency[]) {
+export function createTestBase(workbookConfig?: IWorkbookData, dependencies?: Dependency[]) {
     const univer = new Univer();
 
     let get: Injector['get'] | undefined;