@cool-office/drawing-ui 0.0.0-stage → 1.2.0

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

@@ -0,0 +1,29 @@
+/**
+ * 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 { IUniverDrawingUIConfig } from './config/config';
+import { IConfigService, Injector, Plugin } from '@cool-office/core';
+export declare class UniverDrawingMobileUIPlugin extends Plugin {
+    private readonly _config;
+    protected readonly _injector: Injector;
+    private readonly _configService;
+    static pluginName: string;
+    static packageName: string;
+    static version: string;
+    constructor(_config: Partial<IUniverDrawingUIConfig> | undefined, _injector: Injector, _configService: IConfigService);
+    onStarting(): void;
+    onRendered(): void;
+    private _initDependencies;
+}

package/lib/types/plugin.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 { IUniverDrawingUIConfig } from './config/config';
+import { IConfigService, Injector, Plugin } from '@cool-office/core';
+export declare class UniverDrawingUIPlugin extends Plugin {
+    private readonly _config;
+    protected _injector: Injector;
+    private readonly _configService;
+    static pluginName: string;
+    static packageName: string;
+    static version: string;
+    constructor(_config: Partial<IUniverDrawingUIConfig> | undefined, _injector: Injector, _configService: IConfigService);
+    onStarting(): void;
+    onRendered(): void;
+    private _initDependencies;
+}

package/lib/types/services/drawing-image-clip.service.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 { IDisposable, Nullable } from '@cool-office/core';
+import type { IImageShapeClipService, IShapeClipBounds, UniverRenderingContext } from '@cool-office/engine-render';
+import { Disposable } from '@cool-office/core';
+export declare const IMAGE_CLIP_SHAPE_PICKER_COMPONENT = "sheet.image-clip.shape.picker.component";
+/**
+ * Delegate function type for building a shape clip path.
+ * The function should call ctx.beginPath(), build the shape outline path, and call ctx.clip().
+ * Coordinate system: (0,0) is at the top-left of the shape area.
+ * @returns The actual bounding rect of the clip region, or false if no clip was built
+ */
+export type ImageShapeClipDelegate = (ctx: UniverRenderingContext, prstGeom: string, width: number, height: number, adjustValues?: Nullable<Record<string, number>>) => IShapeClipBounds | false;
+/**
+ * Bridge service that enables shape-based image clipping.
+ * This service lives in the open-source drawing-ui package and delegates
+ * to a registered clip implementation (provided by pro engine-shape package).
+ *
+ * When no delegate is registered, applyShapeClip returns false and images render normally without shape clipping.
+ */
+export declare class DrawingImageClipService extends Disposable implements IImageShapeClipService {
+    private _clipDelegate;
+    private readonly _canUseShapeClip$;
+    readonly canUseShapeClip$: import("rxjs").Observable<boolean>;
+    constructor();
+    setCanUseShapeClip(canUse: boolean): void;
+    /**
+     * Register a clip delegate that knows how to build shape clip paths.
+     * Typically called by the pro-side plugin with a ShapeModel-based implementation.
+     * @returns IDisposable to unregister the delegate
+     */
+    registerClipDelegate(delegate: ImageShapeClipDelegate): IDisposable;
+    applyShapeClip(ctx: UniverRenderingContext, prstGeom: string, width: number, height: number, adjustValues?: Nullable<Record<string, number>>): IShapeClipBounds | false;
+    dispose(): void;
+}

package/lib/types/services/drawing-render.service.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { IDrawingParam, IDrawingSearch } from '@cool-office/core';
+import type { IDocFloatDomData, IImageData } from '@cool-office/drawing';
+import type { BaseObject, IRectProps, Scene } from '@cool-office/engine-render';
+import { BooleanNumber, IImageIoService, IUniverInstanceService, IURLImageService, PositionedObjectLayoutType } from '@cool-office/core';
+import { IDrawingManagerService } from '@cool-office/drawing';
+import { Image, Rect } from '@cool-office/engine-render';
+import { IGalleryService } from '@cool-office/ui';
+import { DrawingImageClipService } from './drawing-image-clip.service';
+type IDrawingParamWithBehindText = (Partial<IDrawingParam> | Partial<IImageData>) & {
+    behindText?: boolean | BooleanNumber;
+    behindDoc?: BooleanNumber;
+    layoutType?: PositionedObjectLayoutType;
+    docxHeaderFooterDrawing?: boolean;
+};
+export declare const DOC_DRAWING_BEHIND_TEXT_LAYER_INDEX = 1;
+export declare function getDrawingRenderLayerIndex(param: IDrawingParamWithBehindText): number;
+export declare function ensureDrawingRenderLayer(scene: Scene, object: BaseObject, param: IDrawingParamWithBehindText): void;
+export declare class DrawingRenderService {
+    private readonly _drawingManagerService;
+    private readonly _imageIoService;
+    private readonly _galleryService;
+    private readonly _urlImageService;
+    private readonly _univerInstanceService;
+    private readonly _drawingImageClipService;
+    constructor(_drawingManagerService: IDrawingManagerService, _imageIoService: IImageIoService, _galleryService: IGalleryService, _urlImageService: IURLImageService, _univerInstanceService: IUniverInstanceService, _drawingImageClipService: DrawingImageClipService);
+    renderImages(imageParam: IImageData, scene: Scene, options?: {
+        allowInactiveSheet?: boolean;
+    }): Promise<Image[] | undefined>;
+    private _getActiveSheetId;
+    renderFloatDom(param: IDocFloatDomData, scene: Scene): Rect<IRectProps>[] | undefined;
+    renderDrawing(param: IDrawingSearch, scene: Scene, options?: {
+        allowInactiveSheet?: boolean;
+    }): Promise<Image[] | undefined> | undefined;
+    previewImage(key: string, src: string, width: number, height: number): void;
+    private _adjustImageSize;
+}
+export {};

package/lib/types/utils/clipboard-image.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { IImageIoService } from '@cool-office/core';
+import { ImageSourceType } from '@cool-office/core';
+export declare function extractClipboardImageFiles(clipboardData: DataTransfer): File[];
+export declare function isClipboardTextImage(text: string): boolean;
+export declare function extractClipboardTextImageFile(text: string): Promise<File | null>;
+export declare function isImageOnlyClipboardHtml(html: string): boolean;
+export declare function extractClipboardHtmlImageFiles(html: string): Promise<File[]>;
+export declare function normalizeClipboardImageFile(file: File): Promise<File | null>;
+export declare function svgImageFileToDataUrl(file: File): Promise<string | null>;
+export declare function writeImageSourceToClipboard(source: string, imageSourceType?: ImageSourceType, imageIoService?: IImageIoService): Promise<boolean>;

package/lib/types/utils/config.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+export declare const MIN_DRAWING_WIDTH_LIMIT = 20;
+export declare const MIN_DRAWING_HEIGHT_LIMIT = 20;
+export declare const RANGE_DRAWING_ROTATION_LIMIT: number[];

package/lib/types/utils/get-update-params.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 { IDrawingParam, Nullable } from '@cool-office/core';
+import type { IDrawingManagerService } from '@cool-office/drawing';
+import type { BaseObject } from '@cool-office/engine-render';
+export declare function getUpdateParams(objects: Map<string, BaseObject>, drawingManagerService: IDrawingManagerService): Nullable<IDrawingParam>[];

package/lib/types/utils/image-crop-transform.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { BaseObject } from '@cool-office/engine-render';
+/** Crop insets in image coordinates, accounting for rotation around different centers. */
+export declare function getImageCropRect(image: Pick<BaseObject, 'left' | 'top' | 'width' | 'height' | 'angle'>, crop: Pick<BaseObject, 'left' | 'top' | 'width' | 'height'>): {
+    srcRect: {
+        left: number;
+        top: number;
+        right: number;
+        bottom: number;
+    };
+    srcRectAngle: {
+        left: number;
+        top: number;
+        right: number;
+        bottom: number;
+    };
+};

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

@@ -0,0 +1,19 @@
+/**
+ * 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 '@cool-office/core';
+import type { IDrawingRotateEnabledResolverOptions } from '@cool-office/drawing';
+export declare function isKnownDrawingUINonRotatableType(drawingType: DrawingType): boolean;
+export declare function resolveDrawingUIRotateEnabled(drawing: IDrawingParam, options?: IDrawingRotateEnabledResolverOptions): boolean;

package/lib/types/views/crop/MobileCropActions.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export declare function MobileCropActions(): import("react").JSX.Element | null;

package/lib/types/views/crop/image-cropper-object.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { ISrcRect, ITransformState, Nullable } from '@cool-office/core';
+import type { IShapeProps, IViewportInfo, UniverRenderingContext, Vector2 } from '@cool-office/engine-render';
+import { Shape } from '@cool-office/engine-render';
+export interface IImageCropperObjectProps extends IShapeProps {
+    /**
+     * 20.1.8.55 srcRect (Source Rectangle)
+     */
+    srcRect?: Nullable<ISrcRect>;
+    /**
+     * 20.1.9.18 prstGeom (Preset geometry)
+     */
+    prstGeom?: Nullable<string>;
+    applyTransform?: ITransformState;
+    dragPadding?: number;
+}
+export declare class ImageCropperObject<T extends IImageCropperObjectProps = IImageCropperObjectProps> extends Shape<T> {
+    private _srcRect;
+    private _prstGeom;
+    private _applyTransform;
+    private _dragPadding;
+    private _cacheCanvas;
+    constructor(key?: string, props?: T);
+    refreshSrcRect(value: Nullable<ISrcRect>, transform: Nullable<ITransformState>): void;
+    get srcRect(): Nullable<ISrcRect>;
+    dispose(): void;
+    isHit(coord: Vector2): boolean;
+    private _inSurround;
+    render(mainCtx: UniverRenderingContext, bounds?: IViewportInfo): this;
+    protected _draw(ctx: UniverRenderingContext): void;
+    private _clipForApplyObject;
+    private _applyProps;
+    private _applyCache;
+    private _initialCacheCanvas;
+}

package/lib/types/views/image-popup-menu/ImagePopupMenu.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 { IValueOption } from '@cool-office/ui';
+export interface IImagePopupMenuItem {
+    label: string;
+    index: number;
+    commandId: string;
+    commandParams?: object;
+    disable: boolean;
+    type?: 'button' | 'select';
+    value?: string;
+    options?: Array<{
+        icon?: string;
+        label: IValueOption['label'];
+        value: string;
+    }>;
+    commandParamsFactory?: (value: string) => object;
+    hideOnClick?: boolean;
+    icon?: string;
+}
+export interface IImagePopupMenuExtraProps {
+    menuItems: IImagePopupMenuItem[];
+    variant?: 'doc-floating-toolbar' | 'doc-chart-floating-toolbar';
+    unitId?: string;
+    subUnitId?: string;
+    drawingId?: string;
+}
+export interface IImagePopupMenuProps {
+    popup: {
+        extraProps?: IImagePopupMenuExtraProps;
+    };
+}
+export declare function ImagePopupMenu(props: IImagePopupMenuProps): import("react").JSX.Element | null;

package/lib/types/views/image-popup-menu/MobileImagePopupMenu.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { IImagePopupMenuExtraProps } from './ImagePopupMenu';
+interface IMobileImagePopupMenuProps {
+    popup: {
+        extraProps?: Pick<IImagePopupMenuExtraProps, 'menuItems' | 'variant'> & {
+            dialogId?: string;
+            onClose?: () => void;
+        };
+    };
+}
+export declare function MobileImagePopupMenu({ popup }: IMobileImagePopupMenuProps): import("react").JSX.Element | null;
+export {};

package/lib/types/views/image-popup-menu/component-name.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+export declare const COMPONENT_IMAGE_POPUP_MENU = "COMPONENT_IMAGE_POPUP_MENU";
+export declare const COMPONENT_MOBILE_IMAGE_POPUP_MENU = "COMPONENT_MOBILE_IMAGE_POPUP_MENU";

package/lib/types/views/image-preview/mobile-image-preview-button.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { ThemeService } from '@cool-office/core';
+import type { Image, Scene, UniverRenderingContext } from '@cool-office/engine-render';
+import { Rect } from '@cool-office/engine-render';
+/** Transient canvas chrome: never part of the image model or its transformer. */
+export declare class MobileImagePreviewButton extends Rect {
+    private readonly _image;
+    private readonly _scene;
+    private _enabled;
+    private readonly _icon;
+    private readonly _iconContainer;
+    private readonly _gesture;
+    private _pressed;
+    private _background;
+    private _border;
+    private _pressedBackground;
+    constructor(_image: Image, _scene: Scene, themeService: ThemeService, preview: () => void);
+    setPreviewEnabled(enabled: boolean): void;
+    dispose(): void;
+    private _setPressed;
+    private _syncPosition;
+    protected _draw(ctx: UniverRenderingContext): void;
+}

package/lib/types/views/object-list-panel/MobileObjectListPanel.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 { IObjectListPanelBaseProps } from './ObjectListPanelBase';
+export declare function MobileObjectListPanel(props: IObjectListPanelBaseProps): import("react").JSX.Element;