@univerjs/core 0.20.0 → 0.20.1

package/lib/types/services/authz-io/authz-io-local.service.d.ts

@@ -25,6 +25,11 @@ export declare class AuthzIoLocalService implements IAuthzIoService {
     private _userManagerService;
     private _permissionMap;
     private _permissionOverrides;
+    /**
+     * Whether the document owner inherits permissions for all protected ranges.
+     * If true, the document owner cannot be selected when specifying user edits for a protected range, and the document owner will have edit permissions for all protected ranges by default.
+     */
+    private _cfgEnableObjInherit;
     constructor(_resourceManagerService: IResourceManagerService, _userManagerService: UserManagerService);
     private _initDefaultUser;
     private _getRole;
@@ -62,4 +67,6 @@ export declare class AuthzIoLocalService implements IAuthzIoService {
     updateCollaborator(): Promise<void>;
     createCollaborator(): Promise<void>;
     putCollaborators(config: IPutCollaboratorsRequest): Promise<void>;
+    setCfgEnableObjInherit(enabled: boolean): void;
+    getCfgEnableObjInherit(): boolean;
 }

package/lib/types/services/authz-io/type.d.ts

@@ -30,5 +30,7 @@ export interface IAuthzIoService {
     deleteCollaborator(config: IDeleteCollaboratorRequest, context?: ILogContext): Promise<void>;
     createCollaborator(config: ICreateCollaboratorRequest, context?: ILogContext): Promise<void>;
     putCollaborators(config: IPutCollaboratorsRequest, context?: ILogContext): Promise<void>;
+    setCfgEnableObjInherit?(enabled: boolean): void;
+    getCfgEnableObjInherit?(): boolean;
 }
 export declare const IAuthzIoService: import("@wendellhu/redi").IdentifierDecorator<IAuthzIoService>;

package/lib/types/shared/date-kit.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+type DateKitCoreUnit = 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
+export type DateKitUnitType = DateKitCoreUnit | 'milliseconds' | 'ms' | 'seconds' | 's' | 'minutes' | 'm' | 'hours' | 'h' | 'days' | 'd' | 'weeks' | 'w' | 'months' | 'M' | 'years' | 'y';
+export type DateKitInput = Date | number | string | IDateKit | null | undefined;
+export interface IDateKit {
+    isValid(): boolean;
+    format(template?: string): string;
+    valueOf(): number;
+    toDate(): Date;
+    add(value: number, unit?: DateKitUnitType): IDateKit;
+    subtract(value: number, unit?: DateKitUnitType): IDateKit;
+    startOf(unit: DateKitUnitType): IDateKit;
+    endOf(unit: DateKitUnitType): IDateKit;
+    utc(): IDateKit;
+    local(): IDateKit;
+    weekday(): number;
+    weekday(value: number): IDateKit;
+    week(): number;
+    week(value: number): IDateKit;
+}
+export type DateKit = IDateKit;
+export type OpUnitType = DateKitUnitType;
+interface IDateKitStatic {
+    (input?: DateKitInput): IDateKit;
+    utc: (input?: DateKitInput) => IDateKit;
+    isDateKit: (value: unknown) => value is IDateKit;
+    unix: (timestamp: number) => IDateKit;
+}
+export declare const dateKit: IDateKitStatic;
+export {};

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

@@ -21,7 +21,8 @@ export { ColorKit, COLORS, type IRgbColor, RGB_PAREN, RGBA_PAREN } from './color
 export * from './command-enum';
 export * from './common';
 export * from './compare';
-export * from './dayjs';
+export type { DateKit, DateKitInput, DateKitUnitType, OpUnitType } from './date-kit';
+export { dateKit } from './date-kit';
 export * from './doc-tool';
 export * from './generate';
 export * from './hash-algorithm';

package/lib/types/shared/tools.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { IStyleData } from '../types/interfaces';
-import type { IKeyValue, Nullable } from './types';
+import type { Nullable } from './types';
 /**
  * Universal tool library
  */
@@ -48,7 +48,7 @@ export declare class Tools {
      * @param obj
      * @returns
      */
-    static removeNull(value: IKeyValue): object;
+    static removeNull(value: Record<string, any>): object;
     static numToWord(x: number): string;
     /**
      * Column subscript letter to number
@@ -71,7 +71,7 @@ export declare class Tools {
      * @param extendJson
      * @returns
      */
-    static commonExtend<T>(originJson: IKeyValue, extendJson: IKeyValue): T;
+    static commonExtend<T>(originJson: Record<string, any>, extendJson: Record<string, any>): T;
     static hasIntersectionBetweenTwoRanges(range1Start: number, range1End: number, range2Start: number, range2End: number): boolean;
     static isStartValidPosition(name: string): boolean;
     static isValidParameter(name: string): boolean;

package/lib/types/shared/types.d.ts

@@ -17,22 +17,6 @@
  * @ignore
  */
 export type Nullable<T> = T | null | undefined | void;
-/**
- * Key value object
- *
- * @ignore
- * @deprecated As it has
- */
-export interface IKeyValue {
-    [key: string]: any;
-}
-/**
- * @ignore
- * @deprecated, use {@link Record} instead.
- */
-export interface IKeyType<T> {
-    [key: string]: T;
-}
 export type DeepReadonly<T> = {
     readonly [P in keyof T]: DeepReadonly<T[P]>;
 };

package/lib/types/sheets/sheet-skeleton.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { Nullable } from '../shared';
+import type { IObjectArrayPrimitiveType, Nullable } from '../shared';
 import type { IDocumentData, IDocumentRenderConfig, IPaddingData } from '../types/interfaces';
 import type { Styles } from './styles';
 import type { ICellData, ICellInfo, ICellWithCoord, IPosition, IRange, ISelectionCell, IWorksheetData } from './typedef';
@@ -27,6 +27,40 @@ import { ObjectMatrix } from '../shared';
 import { ImageCacheMap } from '../shared/cache/image-cache';
 import { Skeleton } from '../skeleton';
 import { HorizontalAlign } from '../types/enum';
+/**
+ * Configuration for a single gap (visual separator between rows or columns).
+ * The gap area is rendered with a background color and diagonal stripes.
+ */
+export interface IGapItem {
+    /** Gap size in pixels */
+    size: number;
+    /** Background color of the gap area. Falls back to ISheetGapConfig.defaultBackgroundColor. */
+    color?: string;
+    /** Diagonal stripe color. Falls back to ISheetGapConfig.defaultStripeColor. */
+    stripeColor?: string;
+}
+/**
+ * Configuration for row/column gaps in a sheet.
+ * Gaps are visual-only separators that do not affect the data model.
+ * They are stored as runtime configuration and are not persisted.
+ */
+export interface ISheetGapConfig {
+    /** Row gaps. Key is the row index; gap appears BEFORE that row. */
+    rowGaps?: IObjectArrayPrimitiveType<IGapItem>;
+    /** Column gaps. Key is the column index; gap appears BEFORE that column. */
+    colGaps?: IObjectArrayPrimitiveType<IGapItem>;
+    /** Default diagonal stripe color (theme primary). Used when gap items don't specify stripeColor. */
+    defaultStripeColor?: string;
+    /** Default background color (lighter primary). Used when gap items don't specify color. */
+    defaultBackgroundColor?: string;
+}
+/**
+ * Optional gap size getter for coordinate calculation functions.
+ */
+export interface IGapSizeGetter {
+    row: (r: number) => number;
+    col: (c: number) => number;
+}
 export interface IGetRowColByPosOptions {
     closeFirst?: boolean;
     /**
@@ -74,6 +108,10 @@ export declare class SheetSkeleton extends Skeleton {
     private _columnWidthAccumulation;
     private _marginTop;
     private _marginLeft;
+    /**
+     * Runtime gap configuration for visual row/column separators.
+     */
+    private _gapConfig;
     /** Scale of Scene */
     protected _scaleX: number;
     protected _scaleY: number;
@@ -100,6 +138,35 @@ export declare class SheetSkeleton extends Skeleton {
     get rowHeaderWidthAndMarginLeft(): number;
     get columnHeaderHeightAndMarginTop(): number;
     get imageCacheMap(): ImageCacheMap;
+    get gapConfig(): ISheetGapConfig;
+    /**
+     * Set runtime gap configuration for visual row/column separators.
+     * This triggers a recalculation of the layout (accumulation arrays, etc.).
+     */
+    setGapConfig(config: ISheetGapConfig): void;
+    private _fillDefaultGapThemeColors;
+    /**
+     * Get the gap size (in px) BEFORE the given row.
+     */
+    getRowGapSize(row: number): number;
+    /**
+     * Get the gap size (in px) BEFORE the given column.
+     */
+    getColGapSize(col: number): number;
+    /**
+     * Returns a gap size getter object for use with coordinate utility functions.
+     */
+    getGapSizeGetter(): IGapSizeGetter | undefined;
+    /**
+     * Check if a Y position (in sheet content coordinates) falls within a row gap.
+     * @returns The row index that the gap precedes, or -1 if not in a gap.
+     */
+    getRowGapAtPosition(y: number): number;
+    /**
+     * Check if an X position (in sheet content coordinates) falls within a column gap.
+     * @returns The column index that the gap precedes, or -1 if not in a gap.
+     */
+    getColGapAtPosition(x: number): number;
     private _generateRowMatrixCache;
     /**
      * Calc columnWidthAccumulation by columnData
@@ -233,18 +300,21 @@ export declare class SheetSkeleton extends Skeleton {
  * @param column
  * @param rowHeightAccumulation
  * @param columnWidthAccumulation
+ * @param rowGapSize Gap size (px) BEFORE this row. The cell startY is shifted by this amount.
+ * @param colGapSize Gap size (px) BEFORE this column. The cell startX is shifted by this amount.
  */
-export declare function getCellCoordByIndexSimple(row: number, column: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[]): IPosition;
+export declare function getCellCoordByIndexSimple(row: number, column: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[], rowGapSize?: number, colGapSize?: number): IPosition;
 /**
  * @description Get the cell position information of the specified row and column, including the position of the cell and the merge info
  * @param {number} row The row index of the cell
  * @param {number} column The column index of the cell
  * @param {number[]} rowHeightAccumulation The accumulated height of each row
  * @param {number[]} columnWidthAccumulation The accumulated width of each column
- * @param {ICellInfo} mergeData The merge information of the cell
+ * @param {ICellInfo} mergeDataInfo The merge information of the cell
+ * @param {IGapSizeGetter} gapSizeGetter Optional getter for gap sizes before specific rows/columns
  * @returns {ICellWithCoord} The cell position information of the specified row and column, including the position information of the cell and the merge information of the cell
  */
-export declare function getCellWithCoordByIndexCore(row: number, column: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[], mergeDataInfo: Nullable<ICellInfo>): ICellWithCoord;
+export declare function getCellWithCoordByIndexCore(row: number, column: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[], mergeDataInfo: Nullable<ICellInfo>, gapSizeGetter?: IGapSizeGetter): ICellWithCoord;
 /**
  * Get x in sheet coordinate. Already handled scrolling and zooming.
  * @param offsetX Offset value from PointerEvent in canvas element.

package/lib/types/sheets/styles.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IKeyType, Nullable } from '../shared';
+import type { Nullable } from '../shared';
 import type { IStyleData } from '../types/interfaces';
 import type { ICellDataForSheetInterceptor } from './typedef';
 /**
@@ -23,7 +23,7 @@ import type { ICellDataForSheetInterceptor } from './typedef';
 export declare class Styles {
     private _styles;
     private _cacheMap;
-    constructor(styles?: IKeyType<Nullable<IStyleData>>);
+    constructor(styles?: Record<string, Nullable<IStyleData>>);
     each(callback: (value: [string, Nullable<IStyleData>], index: number, array: Array<[string, Nullable<IStyleData>]>) => void): this;
     search(data: IStyleData, styleObject: string): string;
     get(id: string | Nullable<IStyleData>): Nullable<IStyleData>;
@@ -31,7 +31,7 @@ export declare class Styles {
     setValue(data: Nullable<IStyleData>): Nullable<string>;
     addCustomStyle(id: string, data: Nullable<IStyleData>): void;
     remove(id: string): void;
-    toJSON(): IKeyType<Nullable<IStyleData>>;
+    toJSON(): Record<string, Nullable<IStyleData>>;
     getStyleByCell(cell: Nullable<ICellDataForSheetInterceptor>): Nullable<IStyleData>;
     private _generateCacheMap;
     private _getExistingStyleId;

package/lib/types/types/interfaces/i-slide-data.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import type { ISize } from '../../shared/shape';
-import type { IKeyType, Nullable } from '../../shared/types';
+import type { Nullable } from '../../shared/types';
 import type { IWorksheetData } from '../../sheets/typedef';
 import type { LocaleType, ThemeColorType } from '../enum';
 import type { ShapeType } from '../enum/prst-geom-type';
@@ -114,7 +114,7 @@ export interface IPageElement {
     /** @deprecated */
     spreadsheet?: {
         worksheet: IWorksheetData;
-        styles: IKeyType<Nullable<IStyleData>>;
+        styles: Record<string, Nullable<IStyleData>>;
     };
     /** @deprecated */
     document?: IDocumentData;