@univerjs/drawing 1.0.0-alpha.1 → 1.0.0-alpha.3

package/lib/index.js

@@ -1,4 +1,4 @@
-import { CommandType, Disposable, DrawingTypeEnum, ICommandService, IConfigService, IImageIoService, IImageIoService as IImageIoService$1, IURLImageService, ImageSourceType, ImageSourceType as ImageSourceType$1, ImageUploadStatusType, ImageUploadStatusType as ImageUploadStatusType$1, Inject, Injector, Plugin, createIdentifier, generateRandomId, merge, mergeOverrideWithDependencies, sortRules, sortRulesByDesc, toDisposable } from "@univerjs/core";
+import { CommandType, Disposable, DrawingTypeEnum, ICommandService, IConfigService, IImageIoService, IURLImageService, ImageSourceType, ImageUploadStatusType, Inject, Injector, Plugin, createIdentifier, generateRandomId, merge, mergeOverrideWithDependencies, sortRules, sortRulesByDesc, toDisposable } from "@univerjs/core";
 import * as json1 from "ot-json1";
 import { Subject } from "rxjs";
 
@@ -56,7 +56,7 @@ const SetDrawingSelectedOperation = {
 //#endregion
 //#region package.json
 var name = "@univerjs/drawing";
-var version = "1.0.0-alpha.1";
+var version = "1.0.0-alpha.3";
 
 //#endregion
 //#region src/config/config.ts
@@ -108,6 +108,23 @@ function _defineProperty(e, r, t) {
 
 //#endregion
 //#region src/services/drawing-manager-impl.service.ts
+function isNonEmptyOp(op) {
+	return Array.isArray(op) && op.length > 0;
+}
+function isJsonValueEqual(left, right) {
+	if (left === right) return true;
+	if (left == null || right == null || typeof left !== "object" || typeof right !== "object") return false;
+	if (Array.isArray(left) || Array.isArray(right)) {
+		if (!Array.isArray(left) || !Array.isArray(right) || left.length !== right.length) return false;
+		return left.every((item, index) => isJsonValueEqual(item, right[index]));
+	}
+	const leftRecord = left;
+	const rightRecord = right;
+	const leftKeys = Object.keys(leftRecord);
+	const rightKeys = Object.keys(rightRecord);
+	if (leftKeys.length !== rightKeys.length) return false;
+	return leftKeys.every((key) => Object.prototype.hasOwnProperty.call(rightRecord, key) && isJsonValueEqual(leftRecord[key], rightRecord[key]));
+}
 /**
 * unitId -> subUnitId -> drawingId -> drawingParam
 */
@@ -208,6 +225,7 @@ var UnitDrawingService = class {
 		Object.keys(data).forEach((subUnitId) => {
 			this._establishDrawingMap(unitId, subUnitId);
 			const subUnitData = data[subUnitId];
+			if ((subUnitData === null || subUnitData === void 0 ? void 0 : subUnitData.data) == null) return;
 			Object.keys(subUnitData.data).forEach((drawingId) => {
 				const drawing = subUnitData.data[drawingId];
 				drawing.unitId = unitId;
@@ -267,10 +285,23 @@ var UnitDrawingService = class {
 		});
 		return this.getBatchRemoveOp(removeParams);
 	}
-	getBatchRemoveOp(removeParams) {
-		var _allToRemove$;
+	_getExpandedBatchRemoveParams(removeParams) {
 		const seenIds = /* @__PURE__ */ new Set();
 		const allToRemove = [];
+		const addDrawing = (drawing) => {
+			if (seenIds.has(drawing.drawingId)) return;
+			seenIds.add(drawing.drawingId);
+			allToRemove.push({
+				unitId: drawing.unitId,
+				subUnitId: drawing.subUnitId,
+				drawingId: drawing.drawingId
+			});
+		};
+		const addSearch = (search) => {
+			if (seenIds.has(search.drawingId)) return;
+			seenIds.add(search.drawingId);
+			allToRemove.push(search);
+		};
 		removeParams.forEach((removeParam) => {
 			const drawing = this.getDrawingByParam(removeParam);
 			if ((drawing === null || drawing === void 0 ? void 0 : drawing.drawingType) === DrawingTypeEnum.DRAWING_GROUP) {
@@ -278,25 +309,28 @@ var UnitDrawingService = class {
 				if (nested) {
 					const { flatChildren, groups } = nested;
 					[...flatChildren !== null && flatChildren !== void 0 ? flatChildren : [], ...groups].forEach((d) => {
-						if (!seenIds.has(d.drawingId)) {
-							seenIds.add(d.drawingId);
-							allToRemove.push({
-								unitId: d.unitId,
-								subUnitId: d.subUnitId,
-								drawingId: d.drawingId
-							});
-						}
+						addDrawing(d);
 					});
-				} else if (!seenIds.has(removeParam.drawingId)) {
-					seenIds.add(removeParam.drawingId);
-					allToRemove.push(removeParam);
-				}
-			} else if (!seenIds.has(removeParam.drawingId)) {
-				seenIds.add(removeParam.drawingId);
-				allToRemove.push(removeParam);
-			}
+				} else addDrawing(drawing);
+			} else if (drawing) addDrawing(drawing);
+			else addSearch(removeParam);
 		});
-		const { unitId, subUnitId } = (_allToRemove$ = allToRemove[0]) !== null && _allToRemove$ !== void 0 ? _allToRemove$ : removeParams[0];
+		return allToRemove;
+	}
+	getBatchRemoveOp(removeParams) {
+		var _ref, _allToRemove$;
+		const allToRemove = this._getExpandedBatchRemoveParams(removeParams);
+		const { unitId, subUnitId } = (_ref = (_allToRemove$ = allToRemove[0]) !== null && _allToRemove$ !== void 0 ? _allToRemove$ : removeParams[0]) !== null && _ref !== void 0 ? _ref : {
+			unitId: "",
+			subUnitId: ""
+		};
+		if (allToRemove.length === 0) return {
+			undo: null,
+			redo: null,
+			unitId,
+			subUnitId,
+			objects: []
+		};
 		const orderArr = this._getDrawingOrder(unitId, subUnitId);
 		const orderIndexMap = /* @__PURE__ */ new Map();
 		orderArr.forEach((id, idx) => orderIndexMap.set(id, idx));
@@ -335,6 +369,7 @@ var UnitDrawingService = class {
 		const invertOps = [];
 		updateParams.forEach((updateParam) => {
 			const { op, invertOp } = this._updateByParam(updateParam);
+			if (!isNonEmptyOp(op)) return;
 			objects.push({
 				unitId: updateParam.unitId,
 				subUnitId: updateParam.subUnitId,
@@ -343,6 +378,16 @@ var UnitDrawingService = class {
 			ops.push(op);
 			invertOps.push(invertOp);
 		});
+		if (ops.length === 0) {
+			const { unitId, subUnitId } = updateParams[0];
+			return {
+				undo: null,
+				redo: null,
+				unitId,
+				subUnitId,
+				objects
+			};
+		}
 		const op = ops.reduce(json1.type.compose, null);
 		const invertOp = invertOps.reduce(json1.type.compose, null);
 		const { unitId, subUnitId } = updateParams[0];
@@ -834,7 +879,12 @@ var UnitDrawingService = class {
 			op: [],
 			invertOp: []
 		};
-		const op = this._getUpdateParamCompareOp(updateParam, object).reduce(json1.type.compose, null);
+		const ops = this._getUpdateParamCompareOp(updateParam, object);
+		if (ops.length === 0) return {
+			op: [],
+			invertOp: []
+		};
+		const op = ops.reduce(json1.type.compose, null);
 		return {
 			op,
 			invertOp: json1.type.invertWithDoc(op, this.drawingManagerData)
@@ -845,15 +895,29 @@ var UnitDrawingService = class {
 		const ops = [];
 		Object.keys(newParam).forEach((key) => {
 			const newVal = newParam[key];
+			const hasOldKey = Object.prototype.hasOwnProperty.call(oldParam, key);
 			const oldVal = oldParam[key];
-			if (oldVal === newVal) return;
-			ops.push(json1.replaceOp([
+			if (hasOldKey && isJsonValueEqual(oldVal, newVal)) return;
+			const path = [
 				unitId,
 				subUnitId,
 				"data",
 				drawingId,
 				key
-			], oldVal, newVal));
+			];
+			if (!hasOldKey) {
+				if (newVal === void 0) return;
+				const op = json1.insertOp(path, newVal);
+				if (isNonEmptyOp(op)) ops.push(op);
+				return;
+			}
+			if (newVal === void 0) {
+				const op = json1.removeOp(path, true);
+				if (isNonEmptyOp(op)) ops.push(op);
+				return;
+			}
+			const op = json1.replaceOp(path, oldVal, newVal);
+			if (isNonEmptyOp(op)) ops.push(op);
 		});
 		return ops;
 	}
@@ -896,7 +960,7 @@ var ImageIoService = class {
 	getImageSourceCache(source, imageSourceType) {
 		const cachedImage = this._imageSourceCache.get(source);
 		if (cachedImage != null) return cachedImage;
-		if (imageSourceType === ImageSourceType$1.BASE64) {
+		if (imageSourceType === ImageSourceType.BASE64) {
 			const image = new Image();
 			image.onload = () => this._change$.next(this._waitCount);
 			image.onerror = () => this._change$.next(this._waitCount);
@@ -906,7 +970,7 @@ var ImageIoService = class {
 		}
 	}
 	addImageSourceCache(source, imageSourceType, imageSource) {
-		if (imageSourceType === ImageSourceType$1.BASE64 || imageSource == null) return;
+		if (imageSourceType === ImageSourceType.BASE64 || imageSource == null) return;
 		this._imageSourceCache.set(source, imageSource);
 	}
 	async getImage(imageId) {
@@ -915,12 +979,12 @@ var ImageIoService = class {
 	async saveImage(imageFile) {
 		return new Promise((resolve, reject) => {
 			if (!DRAWING_IMAGE_ALLOW_IMAGE_LIST.includes(imageFile.type)) {
-				reject(new Error(ImageUploadStatusType$1.ERROR_IMAGE_TYPE));
+				reject(new Error(ImageUploadStatusType.ERROR_IMAGE_TYPE));
 				this._decreaseWaiting();
 				return;
 			}
 			if (imageFile.size > getDrawingImageAllowSize()) {
-				reject(new Error(ImageUploadStatusType$1.ERROR_EXCEED_SIZE));
+				reject(new Error(ImageUploadStatusType.ERROR_EXCEED_SIZE));
 				this._decreaseWaiting();
 				return;
 			}
@@ -930,16 +994,16 @@ var ImageIoService = class {
 				var _evt$target;
 				const replaceSrc = (_evt$target = evt.target) === null || _evt$target === void 0 ? void 0 : _evt$target.result;
 				if (replaceSrc == null) {
-					reject(new Error(ImageUploadStatusType$1.ERROR_IMAGE));
+					reject(new Error(ImageUploadStatusType.ERROR_IMAGE));
 					this._decreaseWaiting();
 					return;
 				}
 				resolve({
 					imageId: generateRandomId(6),
-					imageSourceType: ImageSourceType$1.BASE64,
+					imageSourceType: ImageSourceType.BASE64,
 					source: replaceSrc,
 					base64Cache: replaceSrc,
-					status: ImageUploadStatusType$1.SUCCUSS
+					status: ImageUploadStatusType.SUCCUSS
 				});
 				this._decreaseWaiting();
 			};
@@ -1020,7 +1084,7 @@ let UniverDrawingPlugin = class UniverDrawingPlugin extends Plugin {
 	_initDependencies() {
 		var _this$_config;
 		mergeOverrideWithDependencies([
-			[IImageIoService$1, { useClass: ImageIoService }],
+			[IImageIoService, { useClass: ImageIoService }],
 			[IURLImageService, { useClass: URLImageService }],
 			[IDrawingManagerService, { useClass: DrawingManagerService }]
 		], (_this$_config = this._config) === null || _this$_config === void 0 ? void 0 : _this$_config.override).forEach((d) => this._injector.add(d));
@@ -1038,6 +1102,69 @@ UniverDrawingPlugin = __decorate([
 	__decorateParam(3, ICommandService)
 ], UniverDrawingPlugin);
 
+//#endregion
+//#region src/utils/drawing-group.ts
+const DRAWING_GROUPABLE_TYPES = [
+	DrawingTypeEnum.DRAWING_IMAGE,
+	DrawingTypeEnum.DRAWING_SHAPE,
+	DrawingTypeEnum.DRAWING_CHART,
+	DrawingTypeEnum.DRAWING_GROUP
+];
+function isGroupableDrawingType(type) {
+	return DRAWING_GROUPABLE_TYPES.includes(type);
+}
+const DRAWING_COPY_CONTEXT_KEY = "univer.drawing.copy-plan";
+function cloneDrawing(drawing) {
+	return JSON.parse(JSON.stringify(drawing));
+}
+function copyDrawingWithIdMap(drawing, idMap, options) {
+	const copied = cloneDrawing(drawing);
+	const copiedDrawingId = idMap.get(drawing.drawingId);
+	if (copiedDrawingId == null) return copied;
+	copied.unitId = options.unitId;
+	copied.subUnitId = options.targetSubUnitId;
+	copied.drawingId = copiedDrawingId;
+	if (copied.groupId) {
+		const copiedGroupId = idMap.get(copied.groupId);
+		if (copiedGroupId) copied.groupId = copiedGroupId;
+		else delete copied.groupId;
+	}
+	return copied;
+}
+function createDrawingCopyPlan(drawings, options) {
+	const { generateId = () => generateRandomId(10) } = options;
+	const idMap = /* @__PURE__ */ new Map();
+	drawings.forEach((drawing) => {
+		if (!idMap.has(drawing.drawingId)) idMap.set(drawing.drawingId, generateId());
+	});
+	return {
+		idMap,
+		drawings: drawings.map((drawing) => copyDrawingWithIdMap(drawing, idMap, options))
+	};
+}
+function getOrCreateDrawingCopyPlan(copyContext, drawings, options) {
+	if (copyContext == null) return createDrawingCopyPlan(drawings, options);
+	const cached = copyContext.get(DRAWING_COPY_CONTEXT_KEY);
+	if (cached) {
+		const { generateId = () => generateRandomId(10) } = options;
+		if (!drawings.some((drawing) => !cached.idMap.has(drawing.drawingId))) return cached;
+		drawings.forEach((drawing) => {
+			if (!cached.idMap.has(drawing.drawingId)) cached.idMap.set(drawing.drawingId, generateId());
+		});
+		const incomingDrawingIds = new Set(drawings.map((drawing) => drawing.drawingId));
+		const originalIdByCopiedId = new Map(Array.from(cached.idMap.entries()).map(([drawingId, copiedDrawingId]) => [copiedDrawingId, drawingId]));
+		const retainedDrawings = cached.drawings.filter((drawing) => {
+			const originalDrawingId = originalIdByCopiedId.get(drawing.drawingId);
+			return originalDrawingId == null || !incomingDrawingIds.has(originalDrawingId);
+		});
+		cached.drawings = [...drawings.map((drawing) => copyDrawingWithIdMap(drawing, cached.idMap, options)), ...retainedDrawings];
+		return cached;
+	}
+	const plan = createDrawingCopyPlan(drawings, options);
+	copyContext.set(DRAWING_COPY_CONTEXT_KEY, plan);
+	return plan;
+}
+
 //#endregion
 //#region src/utils/get-image-shape-key.ts
 function getDrawingShapeKeyByDrawingSearch({ unitId, subUnitId, drawingId }, index) {
@@ -1064,4 +1191,30 @@ const getImageSize = async (src) => {
 };
 
 //#endregion
-export { DRAWING_IMAGE_ALLOW_IMAGE_LIST, DRAWING_IMAGE_COUNT_LIMIT, DRAWING_IMAGE_HEIGHT_LIMIT, DRAWING_IMAGE_WIDTH_LIMIT, DrawingManagerService, IDrawingManagerService, IImageIoService, ImageIoService, ImageSourceType, ImageUploadStatusType, SetDrawingSelectedOperation, URLImageService, UnitDrawingService, UniverDrawingPlugin, getDrawingImageAllowSize, getDrawingShapeKeyByDrawingSearch, getImageSize };
+//#region src/utils/rotate-enabled.ts
+function getDrawingKey(drawing) {
+	return `${drawing.unitId}\u0000${drawing.subUnitId}\u0000${drawing.drawingId}`;
+}
+function resolveDrawingRotateEnabled(drawing, options = {}, visiting = /* @__PURE__ */ new Set()) {
+	var _drawing$transform, _options$getRenderObj, _options$isKnownNonRo;
+	const drawingKey = getDrawingKey(drawing);
+	if (visiting.has(drawingKey)) return true;
+	if (drawing.drawingType === DrawingTypeEnum.DRAWING_GROUP) {
+		var _options$getChildren;
+		visiting.add(drawingKey);
+		const children = (_options$getChildren = options.getChildren) === null || _options$getChildren === void 0 ? void 0 : _options$getChildren.call(options, drawing);
+		if (children != null) {
+			const enabled = children.every((child) => resolveDrawingRotateEnabled(child, options, visiting));
+			visiting.delete(drawingKey);
+			return enabled;
+		}
+		visiting.delete(drawingKey);
+	}
+	if (((_drawing$transform = drawing.transform) === null || _drawing$transform === void 0 ? void 0 : _drawing$transform.rotateEnabled) === false) return false;
+	if (((_options$getRenderObj = options.getRenderObject) === null || _options$getRenderObj === void 0 || (_options$getRenderObj = _options$getRenderObj.call(options, drawing)) === null || _options$getRenderObj === void 0 || (_options$getRenderObj = _options$getRenderObj.transformerConfig) === null || _options$getRenderObj === void 0 ? void 0 : _options$getRenderObj.rotateEnabled) === false) return false;
+	if ((_options$isKnownNonRo = options.isKnownNonRotatableType) === null || _options$isKnownNonRo === void 0 ? void 0 : _options$isKnownNonRo.call(options, drawing.drawingType)) return false;
+	return true;
+}
+
+//#endregion
+export { DRAWING_COPY_CONTEXT_KEY, DRAWING_GROUPABLE_TYPES, DRAWING_IMAGE_ALLOW_IMAGE_LIST, DRAWING_IMAGE_COUNT_LIMIT, DRAWING_IMAGE_HEIGHT_LIMIT, DRAWING_IMAGE_WIDTH_LIMIT, DrawingManagerService, IDrawingManagerService, ImageIoService, SetDrawingSelectedOperation, URLImageService, UnitDrawingService, UniverDrawingPlugin, createDrawingCopyPlan, getDrawingImageAllowSize, getDrawingShapeKeyByDrawingSearch, getImageSize, getOrCreateDrawingCopyPlan, isGroupableDrawingType, resolveDrawingRotateEnabled };

package/lib/types/index.d.ts

@@ -24,7 +24,9 @@ export type { IDrawingGroupUpdateParam, IDrawingMap, IDrawingMapItem, IDrawingMa
 export { IDrawingManagerService } from './services/drawing-manager.service';
 export { ImageIoService } from './services/image-io-impl.service';
 export { URLImageService } from './services/url-image.service';
+export { createDrawingCopyPlan, DRAWING_COPY_CONTEXT_KEY, DRAWING_GROUPABLE_TYPES, getOrCreateDrawingCopyPlan, isGroupableDrawingType } from './utils/drawing-group';
+export type { ICreateDrawingCopyPlanOptions, IDrawingCopyPlan } from './utils/drawing-group';
 export { getDrawingShapeKeyByDrawingSearch } from './utils/get-image-shape-key';
 export { getImageSize } from './utils/get-image-size';
-export { IImageIoService, ImageSourceType, ImageUploadStatusType } from '@univerjs/core';
-export type { IImageIoServiceParam } from '@univerjs/core';
+export { resolveDrawingRotateEnabled } from './utils/rotate-enabled';
+export type { IDrawingRotateEnabledResolverOptions } from './utils/rotate-enabled';

package/lib/types/services/drawing-manager-impl.service.d.ts

@@ -80,6 +80,7 @@ export declare class UnitDrawingService<T extends IDrawingParam> implements IUni
     setDrawingData(unitId: string, subUnitId: string, data: IDrawingMapItemData<T>): void;
     getBatchAddOp(insertParams: T[]): IDrawingJsonUndo1;
     getBatchRemoveOpInOder(removeParams: IDrawingSearch[]): IDrawingJsonUndo1;
+    private _getExpandedBatchRemoveParams;
     getBatchRemoveOp(removeParams: IDrawingSearch[]): IDrawingJsonUndo1;
     getBatchUpdateOp(updateParams: T[]): IDrawingJsonUndo1;
     removeNotification(removeParams: IDrawingSearch[]): void;

package/lib/types/utils/drawing-group.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 type { DrawingType, IDrawingParam } from '@univerjs/core';
+import { DrawingTypeEnum } from '@univerjs/core';
+export declare const DRAWING_GROUPABLE_TYPES: readonly [DrawingTypeEnum.DRAWING_IMAGE, DrawingTypeEnum.DRAWING_SHAPE, DrawingTypeEnum.DRAWING_CHART, DrawingTypeEnum.DRAWING_GROUP];
+export declare function isGroupableDrawingType(type: DrawingType): boolean;
+export declare const DRAWING_COPY_CONTEXT_KEY = "univer.drawing.copy-plan";
+export interface ICreateDrawingCopyPlanOptions {
+    unitId: string;
+    sourceSubUnitId: string;
+    targetSubUnitId: string;
+    generateId?: () => string;
+}
+export interface IDrawingCopyPlan<T extends IDrawingParam = IDrawingParam> {
+    idMap: Map<string, string>;
+    drawings: T[];
+}
+export declare function createDrawingCopyPlan<T extends IDrawingParam>(drawings: readonly T[], options: ICreateDrawingCopyPlanOptions): IDrawingCopyPlan<T>;
+export declare function getOrCreateDrawingCopyPlan<T extends IDrawingParam>(copyContext: Map<string, unknown> | undefined, drawings: readonly T[], options: ICreateDrawingCopyPlanOptions): IDrawingCopyPlan<T>;

package/lib/types/utils/rotate-enabled.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 type { DrawingType, IDrawingParam } from '@univerjs/core';
+interface IRotateRenderObject {
+    transformerConfig?: {
+        rotateEnabled?: boolean;
+    };
+}
+export interface IDrawingRotateEnabledResolverOptions {
+    getChildren?: (drawing: IDrawingParam) => readonly IDrawingParam[] | null | undefined;
+    getRenderObject?: (drawing: IDrawingParam) => IRotateRenderObject | null | undefined;
+    isKnownNonRotatableType?: (drawingType: DrawingType) => boolean;
+}
+export declare function resolveDrawingRotateEnabled(drawing: IDrawingParam, options?: IDrawingRotateEnabledResolverOptions, visiting?: Set<string>): boolean;
+export {};