@univerjs/core 0.1.0-beta.3 → 0.1.0-beta.4

package/lib/types/docs/data-model/__tests__/common.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/docs/data-model/{mutation-types.d.ts → action-types.d.ts}

@@ -15,11 +15,16 @@
  */
 import type { UpdateDocsAttributeType } from '../../shared/command-enum';
 import type { IDocumentBody } from '../../types/interfaces/i-document-data';
+export declare enum TextXActionType {
+    RETAIN = "r",
+    INSERT = "i",
+    DELETE = "d"
+}
 /**
  * Retain mutation is used to move the cursor or to update properties of the text in the given range.
  */
 export interface IRetainAction {
-    t: 'r';
+    t: TextXActionType.RETAIN;
     len: number;
     body?: IDocumentBody;
     coverType?: UpdateDocsAttributeType;
@@ -29,7 +34,7 @@ export interface IRetainAction {
  * Insert mutation is used to insert text (maybe with rich text properties) at the given position.
  */
 export interface IInsertAction {
-    t: 'i';
+    t: TextXActionType.INSERT;
     body: IDocumentBody;
     len: number;
     line: number;
@@ -39,7 +44,7 @@ export interface IInsertAction {
  * Delete mutation is used to delete text at the given position.
  */
 export interface IDeleteAction {
-    t: 'd';
+    t: TextXActionType.DELETE;
     len: number;
     line: number;
     segmentId?: string;

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

@@ -16,7 +16,7 @@
 import type { Nullable } from '../../shared';
 import type { IDocumentBody, IDocumentData, IDocumentRenderConfig } from '../../types/interfaces/i-document-data';
 import type { IPaddingData } from '../../types/interfaces/i-style-data';
-import type { TextXAction } from './mutation-types';
+import { type TextXAction } from './action-types';
 export declare const DEFAULT_DOC: {
     id: string;
     documentStyle: {};
@@ -62,7 +62,7 @@ export declare class DocumentDataModel extends DocumentDataModelSimple {
     reset(snapshot: Partial<IDocumentData>): void;
     getSelfOrHeaderFooterModel(segmentId?: string): DocumentDataModel;
     getUnitId(): string;
-    apply(mutations: TextXAction[]): TextXAction[];
+    apply(actions: TextXAction[]): TextXAction[];
     sliceBody(startOffset: number, endOffset: number): Nullable<IDocumentBody>;
     private _updateApply;
     private _deleteApply;

package/lib/types/docs/data-model/text-x/__tests__/action-iterator.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/docs/data-model/text-x/__tests__/compose.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/docs/data-model/text-x/__tests__/utils.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/docs/data-model/text-x/action-iterator.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+import type { TextXAction } from '../action-types';
+import { TextXActionType } from '../action-types';
+export declare class ActionIterator {
+    private _actions;
+    private _index;
+    private _offset;
+    constructor(_actions: TextXAction[]);
+    hasNext(): boolean;
+    next(length?: number): TextXAction;
+    peek(): TextXAction;
+    peekLength(): number;
+    peekType(): TextXActionType;
+    rest(): TextXAction[];
+}

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

@@ -15,7 +15,7 @@
  */
 import type { UpdateDocsAttributeType } from '../../../shared/command-enum';
 import type { IDocumentBody } from '../../../types/interfaces/i-document-data';
-import type { TextXAction } from '../mutation-types';
+import { type TextXAction } from '../action-types';
 export declare class TextX {
     static compose(thisActions: TextXAction[], otherActions: TextXAction[]): TextXAction[];
     private _actions;
@@ -24,4 +24,5 @@ export declare class TextX {
     delete(len: number, segmentId: string): this;
     serialize(): TextXAction[];
     push(...args: TextXAction[]): this;
+    trimEndUselessRetainAction(): this;
 }

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

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+import { UpdateDocsAttributeType } from '../../../shared/command-enum';
+import type { IDocumentBody } from '../../../types/interfaces/i-document-data';
+import type { IRetainAction } from '../action-types';
+export declare function getBodySlice(body: IDocumentBody, startOffset: number, endOffset: number): IDocumentBody;
+export declare function composeBody(thisBody: IDocumentBody, otherBody: IDocumentBody, coverType?: UpdateDocsAttributeType): IDocumentBody;
+export declare function isUselessRetainAction(action: IRetainAction): boolean;

package/lib/types/index.d.ts

@@ -21,7 +21,9 @@ export { MemoryCursor } from './common/memory-cursor';
 export { requestImmediateMacroTask } from './common/request-immediate-macro-task';
 export { type ISequenceExecuteResult, sequence, sequenceAsync } from './common/sequence';
 export * from './docs/data-model';
-export { type TextXAction, type IDeleteAction, type IInsertAction, type IRetainAction, } from './docs/data-model/mutation-types';
+export { TextXActionType, type TextXAction, type IDeleteAction, type IInsertAction, type IRetainAction, } from './docs/data-model/action-types';
+export { ActionIterator } from './docs/data-model/text-x/action-iterator';
+export { getBodySlice, composeBody } from './docs/data-model/text-x/utils';
 export { TextX } from './docs/data-model/text-x/text-x';
 export * from './observer';
 export { Plugin, PluginType } from './plugin/plugin';