@univerjs/core 0.2.3 → 0.2.4

package/lib/types/common/__tests__/url.spec.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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 {};

package/lib/types/common/url.d.ts

@@ -14,3 +14,4 @@
  * limitations under the License.
  */
 export declare function isLegalUrl(url: string): boolean;
+export declare function normalizeUrl(urlStr: string): string;

package/lib/types/docs/data-model/document-data-model.d.ts

@@ -2,6 +2,7 @@ import { Nullable } from '../../shared';
 import { IDocumentBody, IDocumentData, IDocumentRenderConfig, IDocumentStyle, IDrawings } from '../../types/interfaces/i-document-data';
 import { IPaddingData } from '../../types/interfaces/i-style-data';
 import { UnitModel, UniverInstanceType } from '../../common/unit';
+import { SliceBodyType } from './text-x/utils';
 import { JSONXActions } from './json-x/json-x';
 
 export declare const DEFAULT_DOC: {
@@ -53,7 +54,7 @@ export declare class DocumentDataModel extends DocumentDataModelSimple {
     getSelfOrHeaderFooterModel(segmentId?: string): DocumentDataModel;
     getUnitId(): string;
     apply(actions: JSONXActions): IDocumentData | undefined;
-    sliceBody(startOffset: number, endOffset: number): Nullable<IDocumentBody>;
+    sliceBody(startOffset: number, endOffset: number, type?: SliceBodyType): Nullable<IDocumentBody>;
     private _initializeHeaderFooterModel;
     updateDocumentId(unitId: string): void;
 }

package/lib/types/docs/data-model/preset-list-type.d.ts

@@ -1,36 +1,10 @@
-import { BulletAlignment, GlyphType } from '../../types/interfaces/i-document-data';
+import { IListData } from '../../types/interfaces/i-document-data';
 
 export declare enum PresetListType {
     BULLET_LIST = "BULLET_LIST",
     ORDER_LIST = "ORDER_LIST"
 }
 export declare const PRESET_LIST_TYPE: {
-    BULLET_LIST: {
-        listType: PresetListType;
-        nestingLevel: {
-            bulletAlignment: BulletAlignment;
-            glyphFormat: string;
-            textStyle: {
-                fs: number;
-            };
-            startNumber: number;
-            glyphSymbol: string;
-            hanging: number;
-            indentStart: number;
-        }[];
-    };
-    ORDER_LIST: {
-        listType: PresetListType;
-        nestingLevel: {
-            bulletAlignment: BulletAlignment;
-            glyphFormat: string;
-            textStyle: {
-                fs: number;
-            };
-            startNumber: number;
-            glyphType: GlyphType;
-            hanging: number;
-            indentStart: number;
-        }[];
-    };
+    BULLET_LIST: IListData;
+    ORDER_LIST: IListData;
 };

package/lib/types/docs/data-model/text-x/text-x.d.ts

@@ -16,6 +16,7 @@ export declare class TextX {
     insert(len: number, body: IDocumentBody, segmentId?: string): this;
     retain(len: number, segmentId?: string, body?: IDocumentBody, coverType?: UpdateDocsAttributeType): this;
     delete(len: number, segmentId?: string): this;
+    empty(): this;
     serialize(): TextXAction[];
     push(...args: TextXAction[]): this;
     protected trimEndUselessRetainAction(): this;

package/lib/types/docs/data-model/text-x/utils.d.ts

@@ -2,7 +2,11 @@ import { UpdateDocsAttributeType } from '../../../shared/command-enum';
 import { ICustomDecoration, IDocumentBody } from '../../../types/interfaces/i-document-data';
 import { IRetainAction } from './action-types';
 
-export declare function getBodySlice(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyTextRun?: boolean): IDocumentBody;
+export declare enum SliceBodyType {
+    copy = 0,
+    cut = 1
+}
+export declare function getBodySlice(body: IDocumentBody, startOffset: number, endOffset: number, returnEmptyTextRun?: boolean, type?: SliceBodyType): IDocumentBody;
 export declare function normalizeBody(body: IDocumentBody): IDocumentBody;
 export declare function getCustomRangeSlice(body: IDocumentBody, startOffset: number, endOffset: number): {
     customRanges: {
@@ -10,6 +14,7 @@ export declare function getCustomRangeSlice(body: IDocumentBody, startOffset: nu
         endIndex: number;
         rangeId: string;
         rangeType: import('../../../types/interfaces/i-document-data').CustomRangeType;
+        wholeEntity?: boolean;
     }[];
     leftOffset: number;
     rightOffset: number;

package/lib/types/index.d.ts

@@ -31,7 +31,7 @@ export * from './docs/data-model';
 export { TextXActionType, type TextXAction, type IDeleteAction, type IInsertAction, type IRetainAction, } from './docs/data-model/text-x/action-types';
 export { DataValidationRenderMode } from './types/enum/data-validation-render-mode';
 export { ActionIterator } from './docs/data-model/text-x/action-iterator';
-export { getBodySlice, composeBody } from './docs/data-model/text-x/utils';
+export { getBodySlice, composeBody, SliceBodyType } from './docs/data-model/text-x/utils';
 export { TextX } from './docs/data-model/text-x/text-x';
 export type { TPriority } from './docs/data-model/text-x/text-x';
 export { JSONX, JSON1 } from './docs/data-model/json-x/json-x';

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

@@ -11,6 +11,7 @@ export declare class AuthzIoLocalService implements IAuthzIoService {
     private _userManagerService;
     private _permissionMap;
     constructor(_resourceManagerService: IResourceManagerService, _userManagerService: UserManagerService);
+    private _initDefaultUser;
     private _getRole;
     private _initSnapshot;
     create(config: ICreateRequest): Promise<string>;

package/lib/types/services/user-manager/user-manager.service.d.ts

@@ -39,4 +39,5 @@ export declare class UserManagerService {
     getUser<T extends IUser>(userId: string, callBack?: () => void): T | undefined;
     delete(userId: string): void;
     clear(): void;
+    list(): IUser[];
 }

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

@@ -26,4 +26,11 @@ export declare class RxDisposable extends Disposable implements IDisposable {
     protected dispose$: Subject<void>;
     dispose(): void;
 }
+export declare class RCDisposable extends Disposable {
+    private readonly _rootDisposable;
+    private _ref;
+    constructor(_rootDisposable: IDisposable);
+    inc(): void;
+    dec(): void;
+}
 export {};

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

@@ -9,6 +9,11 @@ export declare class Tools {
     static deleteBlank(value?: string): string | undefined;
     static getSystemType(): string;
     static getBrowserType(): string;
+    /**
+     * Use this method without `Tools`.
+     *
+     * @deprecated
+     */
     static generateRandomId(n?: number, alphabet?: string): string;
     static getClassName(instance: object): string;
     static deepMerge(target: any, ...sources: any[]): any;
@@ -37,6 +42,7 @@ export declare class Tools {
     static isAndroid(): boolean;
     static isIPhone(): boolean;
     static isLegalUrl(url: string): boolean;
+    static normalizeUrl(url: string): string;
     static itCount(count: number): Function;
     static hasLength(target: IArguments | any[] | string, length?: number): boolean;
     static capitalize(str: string): string;
@@ -108,3 +114,4 @@ export declare class Tools {
     static set(data: Record<string, any>, propertyPath: string, value: any): void;
     static clamp(value: number, min: number, max: number): number;
 }
+export declare function generateRandomId(n?: number, alphabet?: string): string;

package/lib/types/types/interfaces/i-document-data-interceptor.d.ts

@@ -0,0 +1,10 @@
+import { ICustomDecoration, ICustomRange } from './i-document-data';
+
+export interface ICustomRangeForInterceptor extends ICustomRange {
+    active?: boolean;
+    show?: boolean;
+}
+export interface ICustomDecorationForInterceptor extends ICustomDecoration {
+    active?: boolean;
+    show?: boolean;
+}

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

@@ -30,6 +30,7 @@ export interface IReferenceSource {
     lists?: ILists;
     drawings?: IDrawings;
     drawingsOrder?: string[];
+    headerFooterDrawingsOrder?: string[];
 }
 export interface IDocumentSettings {
     zoomRatio?: number;
@@ -99,6 +100,11 @@ export interface IDocumentBody {
     tables?: ITable[];
     customRanges?: ICustomRange[];
     customDecorations?: ICustomDecoration[];
+    /**
+     * for copy/paste, data of custom-range and other module
+     * it won't save to disk
+     */
+    payloads?: Record<string, string>;
 }
 export interface IDocStyle {
     name: string;
@@ -202,15 +208,14 @@ export interface ICustomRange {
     endIndex: number;
     rangeId: string;
     rangeType: CustomRangeType;
+    /**
+     * display as a whole-entity
+     */
+    wholeEntity?: boolean;
 }
-export interface ICustomRangeForInterceptor extends ICustomRange {
-    active?: boolean;
-    show?: boolean;
-}
-export interface ICustomDecorationForInterceptor extends ICustomDecoration {
-    active?: boolean;
-    show?: boolean;
-}
+/**
+ * @deprecated
+ */
 export declare enum CustomRangeType {
     HYPERLINK = 0,
     FIELD = 1,// 17.16 Fields and Hyperlinks
@@ -218,7 +223,8 @@ export declare enum CustomRangeType {
     BOOKMARK = 3,
     COMMENT = 4,
     CUSTOM = 5,
-    MENTION = 6
+    MENTION = 6,
+    UNI_FORMULA = 7
 }
 /**
  * Custom Block
@@ -271,9 +277,6 @@ export interface IDocStyleBase extends IMargin {
     renderConfig?: IDocumentRenderConfig;
 }
 export interface IDocumentLayout {
-    charSpace?: number;
-    linePitch?: number;
-    gridType?: GridType;
     defaultTabStop?: number;
     characterSpacingControl?: characterSpacingControlType;
     paragraphLineGapDefault?: number;
@@ -317,6 +320,9 @@ export interface IDocumentRenderConfig {
     isRenderStyle?: BooleanNumber;
 }
 export interface ISectionBreakBase {
+    charSpace?: number;
+    linePitch?: number;
+    gridType?: GridType;
     columnProperties?: ISectionColumnProperties[];
     columnSeparatorType?: ColumnSeparatorType;
     contentDirection?: TextDirection;
@@ -458,9 +464,9 @@ export interface ITextStyle extends IStyleBase {
     sa?: number;
 }
 export interface IIndentStart {
-    indentFirstLine?: INumberUnit | number;
-    hanging?: INumberUnit | number;
-    indentStart?: INumberUnit | number;
+    indentFirstLine?: INumberUnit;
+    hanging?: INumberUnit;
+    indentStart?: INumberUnit;
     tabStops?: ITabStop[];
 }
 /**
@@ -474,14 +480,14 @@ export interface IParagraphStyle extends IIndentStart {
     direction?: TextDirection;
     spacingRule?: SpacingRule;
     snapToGrid?: BooleanNumber;
-    spaceAbove?: INumberUnit | number;
-    spaceBelow?: INumberUnit | number;
+    spaceAbove?: INumberUnit;
+    spaceBelow?: INumberUnit;
     borderBetween?: IParagraphBorder;
     borderTop?: IParagraphBorder;
     borderBottom?: IParagraphBorder;
     borderLeft?: IParagraphBorder;
     borderRight?: IParagraphBorder;
-    indentEnd?: INumberUnit | number;
+    indentEnd?: INumberUnit;
     keepLines?: BooleanNumber;
     keepNext?: BooleanNumber;
     wordWrap?: BooleanNumber;
@@ -639,7 +645,7 @@ export declare enum FontStyleType {
 }
 export interface INumberUnit {
     v: number;
-    u: NumberUnitType;
+    u?: NumberUnitType;
 }
 export interface IObjectPositionH {
     relativeFrom: ObjectRelativeFromH;
@@ -676,14 +682,17 @@ export declare enum ObjectRelativeFromV {
 export declare enum NumberUnitType {
     POINT = 0,
     LINE = 1,
-    CHARACTER = 2
+    CHARACTER = 2,
+    PIXEL = 3
 }
 export declare enum AlignTypeH {
     CENTER = 0,
     INSIDE = 1,
     LEFT = 2,
     OUTSIDE = 3,
-    RIGHT = 4
+    RIGHT = 4,
+    BOTH = 5,
+    DISTRIBUTE = 6
 }
 export declare enum AlignTypeV {
     BOTTOM = 0,
@@ -750,5 +759,7 @@ export interface ITransformState extends IAbsoluteTransform, IRotationSkewFlipTr
 export interface IDrawingParam extends IDrawingSearch {
     drawingType: DrawingType;
     transform?: Nullable<ITransformState>;
+    transforms?: Nullable<ITransformState[]>;
+    isMultiTransform?: BooleanNumber;
     groupId?: string;
 }

package/lib/types/types/interfaces/i-range.d.ts

@@ -31,7 +31,19 @@ export declare enum AbsoluteRefType {
     COLUMN = 2,
     ALL = 3
 }
-export interface IRowRange {
+interface IRangeLocation {
+    /**
+     * Id of the Workbook the range belongs to.
+     * When this field is not defined, it should be considered as the range in the currently activated worksheet.
+     */
+    unitId?: string;
+    /**
+     * Id of the Worksheet the range belongs to.
+     * When this field is not defined, it should be considered as the range in the currently activated worksheet.
+     */
+    sheetId?: string;
+}
+export interface IRowRange extends IRangeLocation {
     /**
      * The start row (inclusive) of the range
      * startRow
@@ -43,7 +55,7 @@ export interface IRowRange {
      */
     endRow: number;
 }
-export interface IColumnRange {
+export interface IColumnRange extends IRangeLocation {
     /**
      * The start column (inclusive) of the range
      * startColumn
@@ -193,3 +205,4 @@ export interface IRectLTRB {
     width?: number;
     height?: number;
 }
+export {};

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

@@ -16,6 +16,7 @@
 export * from './i-cell-data';
 export * from './i-column-data';
 export * from './i-document-data';
+export * from './i-document-data-interceptor';
 export * from './i-freeze';
 export * from './i-image-properties';
 export * from './i-placeholder';