@univerjs/sheets-table 0.6.10-experimental.20250418-8830bd4

package/lib/types/commands/commands/add-sheet-table.command.d.ts

@@ -0,0 +1,11 @@
+import { ICommand, IRange } from '@univerjs/core';
+import { ITableOptions } from '../../types/type';
+export interface IAddSheetTableCommandParams {
+    unitId: string;
+    subUnitId: string;
+    range: IRange;
+    id?: string;
+    name?: string;
+    options?: ITableOptions;
+}
+export declare const AddSheetTableCommand: ICommand<IAddSheetTableCommandParams>;

package/lib/types/commands/commands/add-table-theme.command.d.ts

@@ -0,0 +1,8 @@
+import { ICommand } from '@univerjs/core';
+import { RangeThemeStyle } from '@univerjs/sheets';
+export interface IAddTableThemeCommandParams {
+    unitId: string;
+    tableId: string;
+    themeStyle: RangeThemeStyle;
+}
+export declare const AddTableThemeCommand: ICommand<IAddTableThemeCommandParams>;

package/lib/types/commands/commands/delete-sheet-table.command.d.ts

@@ -0,0 +1,3 @@
+import { ICommand } from '@univerjs/core';
+import { IDeleteSheetTableParams } from '../mutations/delete-sheet-table.mutation';
+export declare const DeleteSheetTableCommand: ICommand<IDeleteSheetTableParams>;

package/lib/types/commands/commands/remove-table-theme.command.d.ts

@@ -0,0 +1,7 @@
+import { ICommand } from '@univerjs/core';
+export interface IRemoveTableThemeCommandParams {
+    unitId: string;
+    tableId: string;
+    themeName: string;
+}
+export declare const RemoveTableThemeCommand: ICommand<IRemoveTableThemeCommandParams>;

package/lib/types/commands/commands/set-sheet-table.command.d.ts

@@ -0,0 +1,7 @@
+import { ICommand } from '@univerjs/core';
+import { ITableSetConfig } from '../../types/type';
+export interface ISetSheetTableCommandParams extends ITableSetConfig {
+    unitId: string;
+    tableId: string;
+}
+export declare const SetSheetTableCommand: ICommand<ISetSheetTableCommandParams>;

package/lib/types/commands/commands/set-table-filter.command.d.ts

@@ -0,0 +1,3 @@
+import { ICommand } from '@univerjs/core';
+import { ISetSheetTableParams } from '../mutations/set-table-filter.mutation';
+export declare const SetSheetTableFilterCommand: ICommand<ISetSheetTableParams>;

package/lib/types/commands/commands/sheet-table-row-col.command.d.ts

@@ -0,0 +1,11 @@
+import { ICommand } from '@univerjs/core';
+interface ISheetTableRowColOperationCommandParams {
+    tableId: string;
+    unitId: string;
+    subUnitId: string;
+}
+export declare const SheetTableInsertRowCommand: ICommand<ISheetTableRowColOperationCommandParams>;
+export declare const SheetTableInsertColCommand: ICommand<ISheetTableRowColOperationCommandParams>;
+export declare const SheetTableRemoveRowCommand: ICommand<ISheetTableRowColOperationCommandParams>;
+export declare const SheetTableRemoveColCommand: ICommand<ISheetTableRowColOperationCommandParams>;
+export {};

package/lib/types/commands/mutations/add-sheet-table.mutation.d.ts

@@ -0,0 +1,14 @@
+import { IMutation } from '@univerjs/core';
+import { ITableOptions, ITableRange } from '../../types/type';
+export interface IAddSheetTableParams {
+    unitId: string;
+    subUnitId: string;
+    name: string;
+    range: ITableRange;
+    options?: ITableOptions;
+    tableId?: string;
+    header?: string[];
+}
+export declare const AddSheetTableMutation: IMutation<IAddSheetTableParams & {
+    tableId: string;
+}>;

package/lib/types/commands/mutations/delete-sheet-table.mutation.d.ts

@@ -0,0 +1,7 @@
+import { IMutation } from '@univerjs/core';
+export interface IDeleteSheetTableParams {
+    unitId: string;
+    subUnitId: string;
+    tableId: string;
+}
+export declare const DeleteSheetTableMutation: IMutation<IDeleteSheetTableParams>;

package/lib/types/commands/mutations/set-sheet-table.mutation.d.ts

@@ -0,0 +1,9 @@
+import { IMutation } from '@univerjs/core';
+import { ITableSetConfig } from '../../types/type';
+export interface ISetSheetTableMutationParams {
+    unitId: string;
+    subUnitId: string;
+    tableId: string;
+    config: ITableSetConfig;
+}
+export declare const SetSheetTableMutation: IMutation<ISetSheetTableMutationParams>;

package/lib/types/commands/mutations/set-table-filter.mutation.d.ts

@@ -0,0 +1,11 @@
+import { IMutation } from '@univerjs/core';
+import { ITableFilterItem } from '../../types/type';
+export interface ISetSheetTableParams {
+    unitId: string;
+    tableId: string;
+    column: number;
+    tableFilter: ITableFilterItem | undefined;
+}
+export declare const SetSheetTableFilterMutation: IMutation<ISetSheetTableParams & {
+    tableId: string;
+}>;

package/lib/types/const.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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 PLUGIN_NAME = "SHEET_TABLE_PLUGIN";
+export declare const FEATURE_TABLE_ID = "SHEET_TABLE";
+export declare const DEFAULT_COLUMN_NAME_PREFIX = "Column";

package/lib/types/controllers/sheet-table-range.controller.d.ts

@@ -0,0 +1,9 @@
+import { Disposable } from '@univerjs/core';
+import { IExclusiveRangeService } from '@univerjs/sheets';
+import { TableManager } from '../model/table-manager';
+export declare class SheetTableRangeController extends Disposable {
+    private _tableManager;
+    private _exclusiveRangeService;
+    constructor(_tableManager: TableManager, _exclusiveRangeService: IExclusiveRangeService);
+    private _initRangeListener;
+}

package/lib/types/controllers/sheet-table-ref-range.controller.d.ts

@@ -0,0 +1,19 @@
+import { Disposable, ICommandService, Injector, IUniverInstanceService, LocaleService } from '@univerjs/core';
+import { RefRangeService, SheetInterceptorService } from '@univerjs/sheets';
+import { TableManager } from '../model/table-manager';
+export declare class SheetTableRefRangeController extends Disposable {
+    private readonly _commandService;
+    private readonly _refRangeService;
+    private readonly _univerInstanceService;
+    private _injector;
+    private _sheetInterceptorService;
+    private _tableManager;
+    private _localeService;
+    constructor(_commandService: ICommandService, _refRangeService: RefRangeService, _univerInstanceService: IUniverInstanceService, _injector: Injector, _sheetInterceptorService: SheetInterceptorService, _tableManager: TableManager, _localeService: LocaleService);
+    private _initCommandInterceptor;
+    private _generateTableMutationWithInsertRow;
+    private _generateTableMutationWithInsertCol;
+    private _generateTableMutationWithRemoveRow;
+    private _generateTableMutationWithRemoveCol;
+    private _initCommandListener;
+}

package/lib/types/controllers/sheet-table-theme.controller.d.ts

@@ -0,0 +1,12 @@
+import { Disposable } from '@univerjs/core';
+import { SheetRangeThemeModel, SheetRangeThemeService } from '@univerjs/sheets';
+import { TableManager } from '../model/table-manager';
+export declare class SheetsTableThemeController extends Disposable {
+    private _tableManager;
+    private _sheetRangeThemeService;
+    private _sheetRangeThemeModel;
+    constructor(_tableManager: TableManager, _sheetRangeThemeService: SheetRangeThemeService, _sheetRangeThemeModel: SheetRangeThemeModel);
+    registerTableChangeEvent(): void;
+    private _initDefaultTableTheme;
+    dispose(): void;
+}

package/lib/types/controllers/sheets-table.controller.d.ts

@@ -0,0 +1,19 @@
+import { IRange, Disposable, IResourceManagerService } from '@univerjs/core';
+import { SheetInterceptorService } from '@univerjs/sheets';
+import { TableManager } from '../model/table-manager';
+export declare class SheetsTableController extends Disposable {
+    private _sheetInterceptorService;
+    private _tableManager;
+    private _resourceManagerService;
+    private _tableRangeRTree;
+    constructor(_sheetInterceptorService: SheetInterceptorService, _tableManager: TableManager, _resourceManagerService: IResourceManagerService);
+    getContainerTableWithRange(unitId: string, subUnitId: string, range: IRange): import('../model/table').Table | undefined;
+    private _ensureTableRangeRTree;
+    registerTableChangeEvent(): void;
+    registerTableHeaderInterceptor(): void;
+    private _toJson;
+    private _fromJSON;
+    private _deleteUnitId;
+    private _initSnapshot;
+    dispose(): void;
+}

package/lib/types/controllers/table-filter.controller.d.ts

@@ -0,0 +1,18 @@
+import { Disposable, IUniverInstanceService } from '@univerjs/core';
+import { SheetInterceptorService } from '@univerjs/sheets';
+import { TableManager } from '../model/table-manager';
+export declare class TableFilterController extends Disposable {
+    private _tableManager;
+    private readonly _sheetInterceptorService;
+    private readonly _univerInstanceService;
+    private readonly _tableFilteredOutRows$;
+    readonly tableFilteredOutRows$: import('rxjs').Observable<Readonly<Set<number>>>;
+    private _subscription;
+    constructor(_tableManager: TableManager, _sheetInterceptorService: SheetInterceptorService, _univerInstanceService: IUniverInstanceService);
+    get tableFilteredOutRows(): Set<number>;
+    set tableFilteredOutRows(value: Set<number>);
+    initTableHiddenRowIntercept(): void;
+    private _initFilteredOutRows;
+    registerFilterChangeEvent(): void;
+    dispose(): void;
+}

package/lib/types/controllers/table-theme.factory.d.ts

@@ -0,0 +1,88 @@
+import { IRangeThemeStyleItem, IRangeThemeStyleJSON } from '@univerjs/sheets';
+import { BorderStyleTypes } from '@univerjs/core';
+interface ITableDefaultThemeStyle {
+    name: string;
+    style: Omit<IRangeThemeStyleJSON, 'name'>;
+}
+export declare const tableDefaultBorderStyle: {
+    s: BorderStyleTypes;
+    cl: {
+        rgb: string;
+    };
+};
+export declare const customEmptyThemeWithBorderStyle: Omit<IRangeThemeStyleJSON, 'name'>;
+export declare const processStyleWithBorderStyle: (key: keyof Omit<IRangeThemeStyleJSON, "name">, style: IRangeThemeStyleItem) => IRangeThemeStyleItem | {
+    bd: {
+        t: {
+            s: BorderStyleTypes;
+            cl: {
+                rgb: string;
+            };
+        };
+        b?: undefined;
+        r?: undefined;
+        l?: undefined;
+    };
+    ht?: import('@univerjs/core').Nullable<import('@univerjs/core').HorizontalAlign>;
+    vt?: import('@univerjs/core').Nullable<import('@univerjs/core').VerticalAlign>;
+    bg?: import('@univerjs/core').Nullable<import('@univerjs/core').IColorStyle>;
+    cl?: import('@univerjs/core').Nullable<import('@univerjs/core').IColorStyle>;
+    bl?: import('@univerjs/core').BooleanNumber | undefined;
+    ol?: import('@univerjs/core').ITextDecoration | undefined;
+} | {
+    bd: {
+        b: {
+            s: BorderStyleTypes;
+            cl: {
+                rgb: string;
+            };
+        };
+        t?: undefined;
+        r?: undefined;
+        l?: undefined;
+    };
+    ht?: import('@univerjs/core').Nullable<import('@univerjs/core').HorizontalAlign>;
+    vt?: import('@univerjs/core').Nullable<import('@univerjs/core').VerticalAlign>;
+    bg?: import('@univerjs/core').Nullable<import('@univerjs/core').IColorStyle>;
+    cl?: import('@univerjs/core').Nullable<import('@univerjs/core').IColorStyle>;
+    bl?: import('@univerjs/core').BooleanNumber | undefined;
+    ol?: import('@univerjs/core').ITextDecoration | undefined;
+} | {
+    bd: {
+        r: {
+            s: BorderStyleTypes;
+            cl: {
+                rgb: string;
+            };
+        };
+        t?: undefined;
+        b?: undefined;
+        l?: undefined;
+    };
+    ht?: import('@univerjs/core').Nullable<import('@univerjs/core').HorizontalAlign>;
+    vt?: import('@univerjs/core').Nullable<import('@univerjs/core').VerticalAlign>;
+    bg?: import('@univerjs/core').Nullable<import('@univerjs/core').IColorStyle>;
+    cl?: import('@univerjs/core').Nullable<import('@univerjs/core').IColorStyle>;
+    bl?: import('@univerjs/core').BooleanNumber | undefined;
+    ol?: import('@univerjs/core').ITextDecoration | undefined;
+} | {
+    bd: {
+        l: {
+            s: BorderStyleTypes;
+            cl: {
+                rgb: string;
+            };
+        };
+        t?: undefined;
+        b?: undefined;
+        r?: undefined;
+    };
+    ht?: import('@univerjs/core').Nullable<import('@univerjs/core').HorizontalAlign>;
+    vt?: import('@univerjs/core').Nullable<import('@univerjs/core').VerticalAlign>;
+    bg?: import('@univerjs/core').Nullable<import('@univerjs/core').IColorStyle>;
+    cl?: import('@univerjs/core').Nullable<import('@univerjs/core').IColorStyle>;
+    bl?: import('@univerjs/core').BooleanNumber | undefined;
+    ol?: import('@univerjs/core').ITextDecoration | undefined;
+};
+export declare const tableThemeConfig: ITableDefaultThemeStyle[];
+export {};

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

@@ -0,0 +1,88 @@
+import { ITableFilterItem, ITableInfo, ITableInfoWithUnitId, ITableOptions, ITableRange } from '@univerjs/sheets-table';
+import { FWorkbook } from '@univerjs/sheets/facade';
+/**
+ * @ignore
+ */
+export interface IFWorkbookSheetsTableMixin {
+    /**
+     * Get table information
+     * @param {string} tableId The table id
+     * @returns {ITableInfo} The table information
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fSheet = fWorkbook.getActiveSheet();
+     * const id = fWorkbook.addTable('Table1', {
+     *  unitId: fWorkbook.getId(),
+     *  subUnitId:fSheet.getSheetId(),
+     *  range: {
+     *      startRow: 1,
+     *      startColumn: 1,
+     *      endRow: 10,
+     *      endColumn: 5,
+     * },
+     * }, { showHeader: true });
+     * const tableInfo = fWorkbook.getTableInfo(fWorkbook.getId(), id);
+     * ```
+     */
+    getTableInfo(tableId: string): ITableInfoWithUnitId | undefined;
+    getTableInfoByName(tableName: string): ITableInfoWithUnitId | undefined;
+    /**
+     * Get table list
+     * @returns {ITableInfo[]} The table list
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fSheet = fWorkbook.getActiveSheet();
+     * const id = fWorkbook.addTable('Table1', {
+     *  unitId: fWorkbook.getId(),
+     *  subUnitId:fSheet.getSheetId(),
+     *  range: {
+     *      startRow: 1,
+     *      startColumn: 1,
+     *      endRow: 10,
+     *      endColumn: 5,
+     * },
+     * }, { showHeader: true });
+     * const tableList = fWorkbook.getTableList(fWorkbook.getId());
+     * ```
+     */
+    getTableList(): ITableInfo[];
+    /**
+     * Add table
+     * @param {string} tableName The table name
+     * @param {ITableRange} rangeInfo The table range information
+     * @param {ITableOptions} options The table options
+     * @returns {string} The table id
+     * @example
+     * ```typescript
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fSheet = fWorkbook.getActiveSheet();
+     * const id = fWorkbook.addTable('Table1', {
+     *  unitId: fWorkbook.getId(),
+     *  subUnitId:fSheet.getSheetId(),
+     *  range: {
+     *      startRow: 1,
+     *      startColumn: 1,
+     *      endRow: 10,
+     *      endColumn: 5,
+     * },
+     * }, 'table1' ,{ showHeader: true });
+     * ```
+     */
+    addTable(subUnitId: string, tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise<string | undefined>;
+    setTableFilter(tableId: string, column: number, filter: ITableFilterItem | undefined): void;
+    removeTable(tableId: string): Promise<boolean>;
+}
+export declare class FWorkbookSheetsTableMixin extends FWorkbook implements IFWorkbookSheetsTableMixin {
+    getTableInfo(tableId: string): ITableInfoWithUnitId | undefined;
+    getTableList(): ITableInfoWithUnitId[];
+    addTable(subUnitId: string, tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): Promise<string | undefined>;
+    removeTable(tableId: string): Promise<boolean>;
+    getTableInfoByName(tableName: string): ITableInfoWithUnitId | undefined;
+    setTableFilter(tableId: string, column: number, filter: ITableFilterItem | undefined): Promise<boolean>;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorkbook extends IFWorkbookSheetsTableMixin {
+    }
+}

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

@@ -0,0 +1,17 @@
+import { ITableFilterItem, ITableOptions, ITableRange } from '@univerjs/sheets-table';
+import { FWorksheet } from '@univerjs/sheets/facade';
+/**
+ * @ignore
+ */
+export interface IFWorkSheetTableMixin {
+    addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): string;
+    addTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise<boolean>;
+}
+export declare class FWorkSheetTableMixin extends FWorksheet implements IFWorkSheetTableMixin {
+    addTable(tableName: string, rangeInfo: ITableRange, tableId?: string, options?: ITableOptions): string;
+    addTableFilter(tableId: string, column: number, filter: ITableFilterItem): Promise<boolean>;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorksheet extends IFWorkSheetTableMixin {
+    }
+}

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

@@ -0,0 +1,19 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import './f-workbook';
+import './f-worksheet';
+export type * from './f-workbook';
+export type * from './f-worksheet';

package/lib/types/index.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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 { SheetsTableButtonStateEnum, SheetsTableSortStateEnum, TableColumnDataTypeEnum, TableColumnFilterTypeEnum, TableConditionTypeEnum, TableDateCompareTypeEnum, TableNumberCompareTypeEnum, TableStringCompareTypeEnum } from './types/enum';
+export { UniverSheetTablePlugin } from './plugin';
+export type { ITableColumnJson, ITableConditionFilterItem, ITableData, ITableFilterItem, ITableInfo, ITableInfoWithUnitId, ITableManualFilterItem, ITableOptions, ITableRange, ITableRangeWithState, TableMetaType, TableRelationTupleType } from './types/type';
+export { SheetTableService } from '../src/services/table-service';
+export { TableManager } from '../src/model/table-manager';
+export { isConditionFilter, isManualFilter } from '../src/util';
+export { SheetsTableController } from '../src/controllers/sheets-table.controller';
+export { AddSheetTableCommand } from '../src/commands/commands/add-sheet-table.command';
+export { AddSheetTableMutation } from '../src/commands/mutations/add-sheet-table.mutation';
+export { SetSheetTableFilterCommand } from '../src/commands/commands/set-table-filter.command';
+export { SetSheetTableFilterMutation } from '../src/commands/mutations/set-table-filter.mutation';
+export { DeleteSheetTableCommand } from '../src/commands/commands/delete-sheet-table.command';
+export { DeleteSheetTableMutation } from '../src/commands/mutations/delete-sheet-table.mutation';
+export type { ISetSheetTableParams } from '../src/commands/mutations/set-table-filter.mutation';
+export type { IAddSheetTableParams } from '../src/commands/mutations/add-sheet-table.mutation';
+export type { IDeleteSheetTableParams } from '../src/commands/mutations/delete-sheet-table.mutation';
+export type { IAddSheetTableCommandParams } from './commands/commands/add-sheet-table.command';
+export { SetSheetTableCommand } from './commands/commands/set-sheet-table.command';
+export type { ISetSheetTableCommandParams } from './commands/commands/set-sheet-table.command';
+export type { ITableSetConfig } from './types/type';
+export { SetSheetTableMutation } from './commands/mutations/set-sheet-table.mutation';
+export type { ISetSheetTableMutationParams } from './commands/mutations/set-sheet-table.mutation';
+export type { IAddTableThemeCommandParams } from './commands/commands/add-table-theme.command';
+export { AddTableThemeCommand } from './commands/commands/add-table-theme.command';
+export { RemoveTableThemeCommand } from './commands/commands/remove-table-theme.command';
+export { SheetTableInsertColCommand, SheetTableInsertRowCommand, SheetTableRemoveColCommand, SheetTableRemoveRowCommand } from './commands/commands/sheet-table-row-col.command';
+export { customEmptyThemeWithBorderStyle, processStyleWithBorderStyle } from './controllers/table-theme.factory';

package/lib/types/model/filter-util/condition.d.ts

@@ -0,0 +1,11 @@
+import { IDocumentData, Worksheet } from '@univerjs/core';
+import { TableStringCompareTypeEnum, TableConditionTypeEnum, TableDateCompareTypeEnum, TableNumberCompareTypeEnum } from '../../types/enum';
+import { ICalculatedOptions, ITableConditionFilterItem } from '../../types/type';
+type TableConditionCompareType = TableNumberCompareTypeEnum | TableDateCompareTypeEnum | TableStringCompareTypeEnum;
+export declare function isNumberDynamicFilter(compareType: TableConditionCompareType): compareType is TableNumberCompareTypeEnum;
+export declare function isDateDynamicFilter(compareType: TableConditionCompareType): compareType is TableDateCompareTypeEnum;
+export declare function getConditionExecuteFunc(filter: ITableConditionFilterItem, calculatedOptions: ICalculatedOptions | undefined): ((date: Date) => boolean) | ((value: number) => boolean) | ((value: string) => boolean);
+export declare function getCellValueWithConditionType(sheet: Worksheet, row: number, col: number, conditionType: TableConditionTypeEnum): string | number | Date | null;
+export declare const getStringFromDataStream: (data: IDocumentData) => string;
+export declare function excelSerialToDateTime(serial: number): Date;
+export {};