@univerjs/docs 0.2.2 → 0.2.4-alpha.0

package/lib/types/basics/__tests__/plain-text.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/basics/custom-decoration-factory.d.ts

@@ -1,5 +1,4 @@
-import { CustomDecorationType, IMutationInfo, ITextRange } from '@univerjs/core';
-import { IAccessor } from '@wendellhu/redi';
+import { CustomDecorationType, IAccessor, IMutationInfo, ITextRange } from '@univerjs/core';
 import { IRichTextEditingMutationParams } from '../commands/mutations/core-editing.mutation';
 
 interface IAddCustomDecorationParam {

package/lib/types/basics/custom-range-factory.d.ts

@@ -1,5 +1,4 @@
-import { CustomRangeType, IDocumentBody, IMutationInfo, ITextRange } from '@univerjs/core';
-import { IAccessor } from '@wendellhu/redi';
+import { CustomRangeType, IAccessor, IDocumentBody, IMutationInfo, ITextRange } from '@univerjs/core';
 import { IRichTextEditingMutationParams } from '../commands/mutations/core-editing.mutation';
 
 interface IAddCustomRangeParam {
@@ -14,6 +13,7 @@ interface IAddCustomRangeFactoryParam {
     segmentId?: string;
     rangeId: string;
     rangeType: CustomRangeType;
+    wholeEntity?: boolean;
 }
 export declare function addCustomRangeBySelectionFactory(accessor: IAccessor, param: IAddCustomRangeFactoryParam): false | IMutationInfo<IRichTextEditingMutationParams>;
 export interface IDeleteCustomRangeParam {

package/lib/types/basics/plain-text.d.ts

@@ -0,0 +1,6 @@
+import { IDocumentData } from '@univerjs/core';
+
+/**
+ * get plain text from rich-text
+ */
+export declare const getPlainTextFormDocument: (data: IDocumentData) => string;

package/lib/types/basics/replace.d.ts

@@ -0,0 +1,12 @@
+import { IAccessor, IDeleteAction, IDocumentBody, IMutationInfo, IRetainAction, ITextRange } from '@univerjs/core';
+import { ITextRangeWithStyle } from '@univerjs/engine-render';
+import { IRichTextEditingMutationParams } from '../commands/mutations/core-editing.mutation';
+
+export declare function getRetainAndDeleteAndExcludeLineBreak(selection: ITextRange, body: IDocumentBody, segmentId?: string, memoryCursor?: number): Array<IRetainAction | IDeleteAction>;
+export interface IReplaceSelectionFactoryParams {
+    unitId: string;
+    selection?: ITextRange;
+    body: IDocumentBody;
+    textRanges?: ITextRangeWithStyle[];
+}
+export declare function replaceSelectionFactory(accessor: IAccessor, params: IReplaceSelectionFactoryParams): false | IMutationInfo<IRichTextEditingMutationParams>;

package/lib/types/basics/selection.d.ts

@@ -1,4 +1,5 @@
 import { IDocumentBody, ITextRange, Nullable } from '@univerjs/core';
+import { DeleteDirection } from '../types/enums/delete-direction';
 
 export declare function normalizeSelection(selection: ITextRange): {
     startOffset: number;
@@ -13,11 +14,7 @@ export declare function getSelectionWithNoSymbolSide(selection: ITextRange, body
     startOffset: number;
     endOffset: number;
 };
-export declare function getDeleteSelection(selection: ITextRange, body: IDocumentBody): {
-    collapsed: boolean;
-    startOffset: number;
-    endOffset: number;
-};
+export declare function getDeleteSelection<T extends ITextRange>(selection: T, body: IDocumentBody, direction?: DeleteDirection): T;
 export declare function getInsertSelection(selection: ITextRange, body: IDocumentBody): ITextRange;
 /**
  * Ensure custom-range has a correct order,
@@ -26,3 +23,4 @@ export declare function getInsertSelection(selection: ITextRange, body: IDocumen
  */
 export declare function getSelectionForAddCustomRange(selection: ITextRange, body: IDocumentBody): Nullable<ITextRange>;
 export declare function getSelectionText(dataStream: string, start: number, end: number): string;
+export declare function isSegmentIntersects(start: number, end: number, start2: number, end2: number): boolean;

package/lib/types/commands/commands/__tests__/create-command-test-bed.d.ts

@@ -1,16 +1,15 @@
-import { DocumentDataModel, IDocumentData, Nullable, IUniverInstanceService, RxDisposable, Univer } from '@univerjs/core';
-import { Dependency, DependencyIdentifier, Injector } from '@wendellhu/redi';
+import { Dependency, DependencyIdentifier, DocumentDataModel, IDocumentData, Nullable, Injector, IUniverInstanceService, RxDisposable, Univer } from '@univerjs/core';
 import { DocumentSkeleton, IRender, IRenderContext, IRenderModule, DocumentViewModel, IRenderManagerService } from '@univerjs/engine-render';
 
 export declare function createCommandTestBed(workbookData?: IDocumentData, dependencies?: Dependency[]): {
     univer: Univer;
     get: {
-        <T>(id: DependencyIdentifier<T>, lookUp?: import('@wendellhu/redi').LookUp): T;
-        <T>(id: DependencyIdentifier<T>, quantity: import("@wendellhu/redi").Quantity.MANY, lookUp?: import('@wendellhu/redi').LookUp): T[];
-        <T>(id: DependencyIdentifier<T>, quantity: import("@wendellhu/redi").Quantity.OPTIONAL, lookUp?: import('@wendellhu/redi').LookUp): T | null;
-        <T>(id: DependencyIdentifier<T>, quantity: import("@wendellhu/redi").Quantity.REQUIRED, lookUp?: import('@wendellhu/redi').LookUp): T;
-        <T>(id: DependencyIdentifier<T>, quantity?: import('@wendellhu/redi').Quantity, lookUp?: import('@wendellhu/redi').LookUp): T[] | T | null;
-        <T>(id: DependencyIdentifier<T>, quantityOrLookup?: import('@wendellhu/redi').Quantity | import('@wendellhu/redi').LookUp, lookUp?: import('@wendellhu/redi').LookUp): T[] | T | null;
+        <T>(id: DependencyIdentifier<T>, lookUp?: import('@univerjs/core').LookUp): T;
+        <T>(id: DependencyIdentifier<T>, quantity: import("@univerjs/core").Quantity.MANY, lookUp?: import('@univerjs/core').LookUp): T[];
+        <T>(id: DependencyIdentifier<T>, quantity: import("@univerjs/core").Quantity.OPTIONAL, lookUp?: import('@univerjs/core').LookUp): T | null;
+        <T>(id: DependencyIdentifier<T>, quantity: import("@univerjs/core").Quantity.REQUIRED, lookUp?: import('@univerjs/core').LookUp): T;
+        <T>(id: DependencyIdentifier<T>, quantity?: import('@univerjs/core').Quantity, lookUp?: import('@univerjs/core').LookUp): T[] | T | null;
+        <T>(id: DependencyIdentifier<T>, quantityOrLookup?: import('@univerjs/core').Quantity | import('@univerjs/core').LookUp, lookUp?: import('@univerjs/core').LookUp): T[] | T | null;
     };
     doc: DocumentDataModel;
 };

package/lib/types/commands/commands/__tests__/mock-text-selection-render-manager.d.ts

@@ -7,4 +7,4 @@ export declare class TextSelectionRenderManager {
     removeAllTextRanges(): void;
     addTextRanges(): void;
 }
-export declare const ITextSelectionRenderManager: import('@wendellhu/redi').IdentifierDecorator<TextSelectionRenderManager>;
+export declare const ITextSelectionRenderManager: import('@univerjs/core').IdentifierDecorator<TextSelectionRenderManager>;

package/lib/types/commands/commands/clipboard.inner.command.d.ts

@@ -1,4 +1,4 @@
-import { ICommand, IDocumentBody } from '@univerjs/core';
+import { ICommand, IDocumentBody, ITextRange } from '@univerjs/core';
 import { ITextRangeWithStyle } from '@univerjs/engine-render';
 
 export interface IInnerPasteCommandParams {
@@ -10,5 +10,6 @@ export declare const InnerPasteCommand: ICommand<IInnerPasteCommandParams>;
 export interface IInnerCutCommandParams {
     segmentId: string;
     textRanges: ITextRangeWithStyle[];
+    selections?: ITextRange[];
 }
 export declare const CutContentCommand: ICommand<IInnerCutCommandParams>;

package/lib/types/commands/commands/core-editing.command.d.ts

@@ -1,5 +1,6 @@
 import { ICommand, IDocumentBody, IDocumentData, ITextRange, UpdateDocsAttributeType } from '@univerjs/core';
 import { ITextRangeWithStyle } from '@univerjs/engine-render';
+import { DeleteDirection } from '../../types/enums/delete-direction';
 
 export interface IInsertCommandParams {
     unitId: string;
@@ -14,10 +15,6 @@ export declare const EditorInsertTextCommandId = "doc.command.insert-text";
  * The command to insert text. The changed range could be non-collapsed, mainly use in line break and normal input.
  */
 export declare const InsertCommand: ICommand<IInsertCommandParams>;
-export declare enum DeleteDirection {
-    LEFT = 0,
-    RIGHT = 1
-}
 export interface IDeleteCommandParams {
     unitId: string;
     range: ITextRange;

package/lib/types/commands/commands/delete.command.d.ts

@@ -1,7 +1,14 @@
 import { ICommand } from '@univerjs/core';
 import { IActiveTextRange } from '@univerjs/engine-render';
-import { DeleteDirection } from './core-editing.command';
+import { DeleteDirection } from '../../types/enums/delete-direction';
 
+export interface IDeleteCustomBlockParams {
+    direction: DeleteDirection;
+    range: IActiveTextRange;
+    unitId: string;
+    drawingId: string;
+}
+export declare const DeleteCustomBlockCommand: ICommand<IDeleteCustomBlockParams>;
 interface IMergeTwoParagraphParams {
     direction: DeleteDirection;
     range: IActiveTextRange;

package/lib/types/commands/commands/list.command.d.ts

@@ -1,4 +1,4 @@
-import { ICommand, IParagraph, PresetListType } from '@univerjs/core';
+import { ICommand, IParagraph, ISectionBreak, PresetListType } from '@univerjs/core';
 import { IActiveTextRange } from '@univerjs/engine-render';
 
 interface IListOperationCommandParams {
@@ -12,4 +12,5 @@ interface IOrderListCommandParams {
 }
 export declare const OrderListCommand: ICommand<IOrderListCommandParams>;
 export declare function getParagraphsInRange(activeRange: IActiveTextRange, paragraphs: IParagraph[]): IParagraph[];
+export declare function findNearestSectionBreak(currentIndex: number, sectionBreaks: ISectionBreak[]): ISectionBreak | undefined;
 export {};

package/lib/types/commands/commands/replace-content.command.d.ts

@@ -1,4 +1,4 @@
-import { ICommand, IDocumentBody } from '@univerjs/core';
+import { ICommand, IDocumentBody, ITextRange } from '@univerjs/core';
 import { ITextRangeWithStyle } from '@univerjs/engine-render';
 
 interface IReplaceContentCommandParams {
@@ -6,6 +6,9 @@ interface IReplaceContentCommandParams {
     body: IDocumentBody;
     textRanges: ITextRangeWithStyle[];
     segmentId?: string;
+    options: {
+        [key: string]: boolean;
+    };
 }
 export declare const ReplaceContentCommand: ICommand<IReplaceContentCommandParams>;
 interface ICoverContentCommandParams {
@@ -14,4 +17,11 @@ interface ICoverContentCommandParams {
     segmentId?: string;
 }
 export declare const CoverContentCommand: ICommand<ICoverContentCommandParams>;
+export interface IReplaceSelectionCommandParams {
+    unitId: string;
+    selection?: ITextRange;
+    body: IDocumentBody;
+    textRanges?: ITextRangeWithStyle[];
+}
+export declare const ReplaceSelectionCommand: ICommand<IReplaceSelectionCommandParams>;
 export {};

package/lib/types/commands/mutations/core-editing.mutation.d.ts

@@ -11,6 +11,9 @@ export interface IRichTextEditingMutationParams extends IMutationCommonParams {
     isCompositionEnd?: boolean;
     noHistory?: boolean;
     debounce?: boolean;
+    options?: {
+        [key: string]: boolean;
+    };
 }
 /**
  * The core mutator to change rich text actions. The execution result would be undo mutation params. Could be directly

package/lib/types/commands/operations/set-doc-zoom-ratio.operation.d.ts

@@ -1,5 +1,4 @@
-import { IOperation } from '@univerjs/core';
-import { IAccessor } from '@wendellhu/redi';
+import { IAccessor, IOperation } from '@univerjs/core';
 
 export interface ISetDocZoomRatioOperationParams {
     zoomRatio: number;

package/lib/types/commands/util.d.ts

@@ -1,5 +1,4 @@
-import { IAccessor } from '@wendellhu/redi';
-import { DocumentDataModel } from '@univerjs/core';
+import { DocumentDataModel, IAccessor } from '@univerjs/core';
 import { DocSkeletonManagerService } from '../services/doc-skeleton-manager.service';
 
 /**

package/lib/types/controllers/custom-range.controller.d.ts

@@ -0,0 +1,11 @@
+import { Disposable, ICommandService, IUniverInstanceService } from '@univerjs/core';
+import { TextSelectionManagerService } from '../services/text-selection-manager.service';
+
+export declare class DocCustomRangeController extends Disposable {
+    private readonly _commandService;
+    private readonly _textSelectionManagerService;
+    private readonly _univerInstanceService;
+    constructor(_commandService: ICommandService, _textSelectionManagerService: TextSelectionManagerService, _univerInstanceService: IUniverInstanceService);
+    private _transformCustomRange;
+    private _initSelectionChange;
+}

package/lib/types/doc-plugin.d.ts

@@ -1,5 +1,4 @@
-import { Plugin, UniverInstanceType } from '@univerjs/core';
-import { Injector } from '@wendellhu/redi';
+import { Injector, Plugin, UniverInstanceType } from '@univerjs/core';
 
 export interface IUniverDocsConfig {
     hasScroll?: boolean;

package/lib/types/index.d.ts

@@ -13,7 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { getSelectionText, getDeleteSelection, getInsertSelection } from './basics/selection';
+export { replaceSelectionFactory } from './basics/replace';
+export { getSelectionText, getDeleteSelection, getInsertSelection, isSegmentIntersects } from './basics/selection';
 export type { IDocObjectParam } from './basics/component-tools';
 export { getDocObject, neoGetDocObject, getDocObjectById } from './basics/component-tools';
 export * from './basics/docs-view-key';
@@ -26,7 +27,7 @@ export { DocCustomRangeService, type ICustomRangeHook } from './services/doc-cus
 export { BreakLineCommand } from './commands/commands/break-line.command';
 export { CutContentCommand, InnerPasteCommand } from './commands/commands/clipboard.inner.command';
 export { InsertCommand, DeleteCommand, UpdateCommand, EditorInsertTextCommandId, type ICoverCommandParams, type IDeleteCommandParams, type IInsertCommandParams, type IUpdateCommandParams, } from './commands/commands/core-editing.command';
-export { DeleteLeftCommand, DeleteRightCommand, MergeTwoParagraphCommand } from './commands/commands/delete.command';
+export { DeleteLeftCommand, DeleteRightCommand, DeleteCustomBlockCommand, MergeTwoParagraphCommand, type IDeleteCustomBlockParams } from './commands/commands/delete.command';
 export { IMEInputCommand, type IIMEInputCommandParams } from './commands/commands/ime-input.command';
 export { SetInlineFormatBoldCommand, SetInlineFormatItalicCommand, SetInlineFormatUnderlineCommand, SetInlineFormatStrikethroughCommand, SetInlineFormatSubscriptCommand, SetInlineFormatSuperscriptCommand, SetInlineFormatFontSizeCommand, SetInlineFormatFontFamilyCommand, SetInlineFormatTextColorCommand, SetInlineFormatTextBackgroundColorCommand, ResetInlineFormatTextBackgroundColorCommand, SetInlineFormatCommand, } from './commands/commands/inline-format.command';
 export { ListOperationCommand, BulletListCommand, OrderListCommand } from './commands/commands/list.command';
@@ -42,3 +43,6 @@ export { MoveCursorOperation, MoveSelectionOperation } from './commands/operatio
 export { SelectAllOperation } from './commands/operations/select-all.operation';
 export { SetDocZoomRatioOperation, type ISetDocZoomRatioOperationParams } from './commands/operations/set-doc-zoom-ratio.operation';
 export { SetTextSelectionsOperation, type ISetTextSelectionsOperationParams, } from './commands/operations/text-selection.operation';
+export { getRetainAndDeleteFromReplace } from './basics/retain-delete-params';
+export { getRichTextEditPath } from './commands/util';
+export { getPlainTextFormDocument } from './basics/plain-text';

package/lib/types/services/doc-custom-range.service.d.ts

@@ -1,18 +1,20 @@
-import { CustomRangeType } from '@univerjs/core';
-import { IDisposable } from '@wendellhu/redi';
+import { ICustomRange, IDisposable } from '@univerjs/core';
 
-export interface ICustomRangeBase {
-    rangeId: string;
-    rangeType: CustomRangeType;
+export interface ICustomRangeData extends ICustomRange {
+    data?: string;
 }
 export interface ICustomRangeHook {
-    onCopyCustomRange?: (range: ICustomRangeBase) => ICustomRangeBase;
+    onCopyCustomRange?: (unitId: string, range: ICustomRangeData) => ICustomRange;
 }
 export declare class DocCustomRangeService {
     private _customRangeHooks;
     addClipboardHook(hook: ICustomRangeHook): IDisposable;
-    copyCustomRange(range: ICustomRangeBase): {
+    copyCustomRange(unitId: string, range: ICustomRangeData): {
+        data?: string;
+        startIndex: number;
+        endIndex: number;
         rangeId: string;
-        rangeType: CustomRangeType;
+        rangeType: import('@univerjs/core').CustomRangeType;
+        wholeEntity?: boolean;
     };
 }

package/lib/types/services/doc-interceptor/doc-interceptor.service.d.ts

@@ -7,7 +7,7 @@ export declare class DocInterceptorService extends Disposable implements IRender
     private readonly _docSkeletonManagerService;
     private _interceptorsByName;
     constructor(_context: IRenderContext<DocumentDataModel>, _docSkeletonManagerService: DocSkeletonManagerService);
-    intercept<T extends IInterceptor<any, any>>(name: T, interceptor: T): import('@wendellhu/redi').IDisposable;
+    intercept<T extends IInterceptor<any, any>>(name: T, interceptor: T): import('@univerjs/core').IDisposable;
     fetchThroughInterceptors<T, C>(name: IInterceptor<T, C>): (initValue: import('@univerjs/core/common/type-util.js').Nullable<T>, initContext: C) => import('@univerjs/core/common/type-util.js').Nullable<T>;
     interceptDocumentViewModel(viewModel: DocumentViewModel): DisposableCollection;
 }

package/lib/types/services/ime-input-manager.service.d.ts

@@ -1,6 +1,5 @@
-import { Nullable } from '@univerjs/core';
+import { IDisposable, Nullable } from '@univerjs/core';
 import { ITextRangeWithStyle } from '@univerjs/engine-render';
-import { IDisposable } from '@wendellhu/redi';
 import { IRichTextEditingMutationParams } from '../commands/mutations/core-editing.mutation';
 
 interface ICacheParams {

package/lib/types/services/text-selection-manager.service.d.ts

@@ -36,11 +36,13 @@ export declare class TextSelectionManagerService extends RxDisposable {
     refreshSelection(): void;
     setCurrentSelection(param: ITextSelectionManagerSearchParam): void;
     setCurrentSelectionNotRefresh(param: ITextSelectionManagerSearchParam): void;
-    getSelections(): Readonly<Nullable<TextRange[]>>;
+    getCurrentSelections(): Readonly<Nullable<TextRange[]>>;
     getActiveTextRange(): Nullable<TextRange>;
     getActiveRange(): Nullable<ITextActiveRange>;
     add(textRanges: ISuccinctTextRangeParam[], isEditing?: boolean): void;
-    replaceTextRanges(textRanges: ISuccinctTextRangeParam[], isEditing?: boolean): void;
+    replaceTextRanges(textRanges: ISuccinctTextRangeParam[], isEditing?: boolean, options?: {
+        [key: string]: boolean;
+    }): void;
     private _syncSelectionFromRenderService;
     private _replaceTextRangesWithNoRefresh;
     private _getTextRanges;

package/lib/types/types/enums/delete-direction.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 declare enum DeleteDirection {
+    LEFT = 0,
+    RIGHT = 1
+}