@univerjs/watermark 0.4.0-nightly.202410290723

package/lib/index.css

@@ -0,0 +1 @@
+.univer-watermark-panel{margin:16px 0}.univer-watermark-panel-type-title{font-size:15px;color:rgb(var(--text-color-secondary))}.univer-watermark-panel-type-select{width:100%;margin-top:16px}.univer-watermark-panel-setting{width:100%;min-height:100px;border-radius:8px}.univer-watermark-panel-footer{display:flex;justify-content:space-between;align-items:center;font-size:12px}.univer-watermark-panel-footer-button-wrapper{display:flex;align-items:center}.univer-watermark-panel-footer-reset{cursor:pointer;white-space:nowrap;color:rgb(var(--primary-color));border-bottom:1px solid rgb(var(--primary-color))}.univer-watermark-text-setting{font-size:14px}.univer-watermark-text-setting-header{font-size:15px;color:rgb(var(--text-color-secondary));margin:16px 0}.univer-watermark-text-setting-font-content{display:flex;justify-content:space-between;align-items:center;margin-bottom:16px}.univer-watermark-text-setting-font-style-part{display:flex;justify-content:space-between;align-items:center;margin-top:16px}.univer-watermark-text-setting-font-style-part:first-child{margin-top:0}.univer-watermark-text-setting-layout-font-wrapper{width:calc(50% - 8px);align-self:flex-start;white-space:nowrap}.univer-watermark-image-setting{font-size:14px}.univer-watermark-input{height:28px;box-sizing:border-box}.univer-watermark-input-content{width:220px}.univer-watermark-icon{width:18px;height:18px;margin:2px}.univer-watermark-icon-wrapper{cursor:pointer;border-radius:4px;width:24px;height:24px}.univer-watermark-icon-wrapper-select,.univer-watermark-icon-wrapper:hover{background-color:rgb(var(--grey-100))}.univer-watermark-icon-wrapper:first-child{margin-left:28px}.univer-watermark-icon-wrapper:last-child{margin-right:28px}.univer-watermark-color-picker-wrapper{padding:16px;border-radius:8px;background-color:#fff;border:1px solid rgb(var(--grey-100))}

package/lib/locale/en-US.json

@@ -0,0 +1,32 @@
+{
+  "univer-watermark": {
+    "title": "Watermark",
+    "type": "Type",
+    "text": "Text",
+    "image": "Image",
+    "uploadImage": "Upload Image",
+    "replaceImage": "Replace Image",
+    "keepRatio": "Keep Ratio",
+    "width": "Width",
+    "height": "Height",
+    "style": "Style Settings",
+    "content": "Content",
+    "textPlaceholder": "Enter text",
+    "fontSize": "Font Size",
+    "direction": "Direction",
+    "ltr": "Left to Right",
+    "rtl": "Right to Left",
+    "inherits": "Inherit",
+    "opacity": "Opacity",
+    "layout": "Layout Settings",
+    "rotate": "Rotate",
+    "repeat": "Repeat",
+    "spacingX": "Horizontal Spacing",
+    "spacingY": "Vertical Spacing",
+    "startX": "Horizontal Start Position",
+    "startY": "Vertical Start Position",
+    "cancel": "Cancel Watermark",
+    "close": "Close Panel",
+    "copy": "Copy Config"
+  }
+}

package/lib/locale/fa-IR.json

@@ -0,0 +1,32 @@
+{
+  "univer-watermark": {
+    "title": "علامت آب",
+    "type": "نوع",
+    "text": "متن",
+    "image": "تصویر",
+    "uploadImage": "آپلود تصویر",
+    "replaceImage": "جایگزینی تصویر",
+    "keepRatio": "حفظ نسبت",
+    "width": "عرض",
+    "height": "ارتفاع",
+    "style": "تنظیمات سبک",
+    "content": "محتوا",
+    "textPlaceholder": "متن را وارد کنید",
+    "fontSize": "اندازه فونت",
+    "direction": "جهت",
+    "ltr": "چپ به راست",
+    "rtl": "راست به چپ",
+    "inherits": "ارث بردن",
+    "opacity": "شفافیت",
+    "layout": "تنظیمات چیدمان",
+    "rotate": "چرخاندن",
+    "repeat": "تکرار",
+    "spacingX": "فاصله افقی",
+    "spacingY": "فاصله عمودی",
+    "startX": "موقعیت شروع افقی",
+    "startY": "موقعیت شروع عمودی",
+    "cancel": "لغو علامت آب",
+    "close": "بستن پنل",
+    "copy": "کپی تنظیمات"
+  }
+}

package/lib/locale/ru-RU.json

@@ -0,0 +1,32 @@
+{
+  "univer-watermark": {
+    "title": "Водяной знак",
+    "type": "Тип",
+    "text": "Текст",
+    "image": "Изображение",
+    "uploadImage": "Загрузить изображение",
+    "replaceImage": "Заменить изображение",
+    "keepRatio": "Сохранить пропорции",
+    "width": "Ширина",
+    "height": "Высота",
+    "style": "Настройки стиля",
+    "content": "Содержание",
+    "textPlaceholder": "Введите текст",
+    "fontSize": "Размер шрифта",
+    "direction": "Направление",
+    "ltr": "Слева направо",
+    "rtl": "Справа налево",
+    "inherits": "Наследовать",
+    "opacity": "Прозрачность",
+    "layout": "Настройки макета",
+    "rotate": "Поворот",
+    "repeat": "Повтор",
+    "spacingX": "Горизонтальный интервал",
+    "spacingY": "Вертикальный интервал",
+    "startX": "Горизонтальная начальная позиция",
+    "startY": "Вертикальная начальная позиция",
+    "cancel": "Отменить водяной знак",
+    "close": "Закрыть панель",
+    "copy": "Копировать конфигурацию"
+  }
+}

package/lib/locale/vi-VN.json

@@ -0,0 +1,32 @@
+{
+  "univer-watermark": {
+    "title": "Hình mờ",
+    "type": "Loại",
+    "text": "Văn bản",
+    "image": "Hình ảnh",
+    "uploadImage": "Tải lên hình ảnh",
+    "replaceImage": "Thay thế hình ảnh",
+    "keepRatio": "Giữ tỷ lệ",
+    "width": "Chiều rộng",
+    "height": "Chiều cao",
+    "style": "Cài đặt kiểu",
+    "content": "Nội dung",
+    "textPlaceholder": "Nhập văn bản",
+    "fontSize": "Kích thước phông chữ",
+    "direction": "Hướng",
+    "ltr": "Trái sang phải",
+    "rtl": "Phải sang trái",
+    "inherits": "Thừa kế",
+    "opacity": "Độ mờ",
+    "layout": "Cài đặt bố cục",
+    "rotate": "Xoay",
+    "repeat": "Lặp lại",
+    "spacingX": "Khoảng cách ngang",
+    "spacingY": "Khoảng cách dọc",
+    "startX": "Vị trí bắt đầu ngang",
+    "startY": "Vị trí bắt đầu dọc",
+    "cancel": "Hủy hình mờ",
+    "close": "Đóng bảng điều khiển",
+    "copy": "Sao chép cấu hình"
+  }
+}

package/lib/locale/zh-CN.json

@@ -0,0 +1,32 @@
+{
+  "univer-watermark": {
+    "title": "水印",
+    "type": "类型",
+    "text": "文本",
+    "image": "图片",
+    "uploadImage": "上传图片",
+    "replaceImage": "替换图片",
+    "keepRatio": "保持比例",
+    "width": "长度",
+    "height": "高度",
+    "style": "样式设置",
+    "content": "内容",
+    "textPlaceholder": "请输入文本",
+    "fontSize": "字体大小",
+    "direction": "方向",
+    "ltr": "从左到右",
+    "rtl": "从右到左",
+    "inherits": "继承",
+    "opacity": "透明度",
+    "layout": "布局设置",
+    "rotate": "旋转",
+    "repeat": "重复",
+    "spacingX": "水平间距",
+    "spacingY": "垂直间距",
+    "startX": "水平起始位置",
+    "startY": "垂直起始位置",
+    "cancel": "取消水印",
+    "close": "关闭面板",
+    "copy": "复制配置"
+  }
+}

package/lib/locale/zh-TW.json

@@ -0,0 +1,32 @@
+{
+  "univer-watermark": {
+    "title": "浮水印",
+    "type": "類型",
+    "text": "文字",
+    "image": "圖片",
+    "uploadImage": "上傳圖片",
+    "replaceImage": "替換圖片",
+    "keepRatio": "保持比例",
+    "width": "長度",
+    "height": "高度",
+    "style": "樣式設置",
+    "content": "內容",
+    "textPlaceholder": "請輸入文字",
+    "fontSize": "字體大小",
+    "direction": "方向",
+    "ltr": "從左到右",
+    "rtl": "從右到左",
+    "inherits": "繼承",
+    "opacity": "透明度",
+    "layout": "佈局設置",
+    "rotate": "旋轉",
+    "repeat": "重複",
+    "spacingX": "水平間距",
+    "spacingY": "垂直間距",
+    "startX": "水平起始位置",
+    "startY": "垂直起始位置",
+    "cancel": "取消浮水印",
+    "close": "關閉面板",
+    "copy": "複製配置"
+  }
+}

package/lib/types/commands/operations/open-watermark-panel.operation.d.ts

@@ -0,0 +1,2 @@
+import { ICommand } from '@univerjs/core';
+export declare const OpenWatermarkPanelOperation: ICommand;

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

@@ -0,0 +1,10 @@
+import { IImageWatermarkConfig, ITextWatermarkConfig, IUserInfoWatermarkConfig } from './type';
+export declare const UNIVER_WATERMARK_MENU = "UNIVER_WATERMARK_MENU";
+export declare const WATERMARK_PANEL = "WATERMARK_PANEL";
+export declare const WATERMARK_PANEL_FOOTER = "WATERMARK_PANEL_FOOTER";
+export declare const UNIVER_WATERMARK_STORAGE_KEY = "UNIVER_WATERMARK_STORAGE_KEY";
+export declare const UNIVER_WATERMARK_LAYER_INDEX = 10;
+export declare const WATERMARK_IMAGE_ALLOW_IMAGE_LIST: string[];
+export declare const WatermarkTextBaseConfig: ITextWatermarkConfig;
+export declare const WatermarkImageBaseConfig: IImageWatermarkConfig;
+export declare const WatermarkUserInfoBaseConfig: IUserInfoWatermarkConfig;

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

@@ -0,0 +1,59 @@
+/**
+ * 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 IWatermarkTypeEnum {
+    UserInfo = "userInfo",
+    Text = "text",
+    Image = "image"
+}
+export interface IGeneralWatermarkConfig {
+    x: number;
+    y: number;
+    repeat: boolean;
+    spacingX: number;
+    spacingY: number;
+    rotate: number;
+    opacity: number;
+}
+export interface ITextWatermarkConfig extends IGeneralWatermarkConfig {
+    content?: string;
+    fontSize: number;
+    color: string;
+    bold: boolean;
+    italic: boolean;
+    direction: 'ltr' | 'rtl' | 'inherit';
+}
+export interface IImageWatermarkConfig extends IGeneralWatermarkConfig {
+    url: string;
+    width: number;
+    height: number;
+    maintainAspectRatio: boolean;
+    originRatio: number;
+}
+export interface IUserInfoWatermarkConfig extends IGeneralWatermarkConfig, Omit<ITextWatermarkConfig, 'content'> {
+    name: boolean;
+    email: boolean;
+    phone: boolean;
+    uid: boolean;
+}
+export interface IWatermarkConfig {
+    text?: ITextWatermarkConfig;
+    image?: IImageWatermarkConfig;
+    userInfo?: IUserInfoWatermarkConfig;
+}
+export interface IWatermarkConfigWithType {
+    config: IWatermarkConfig;
+    type: IWatermarkTypeEnum;
+}

package/lib/types/controllers/config.schema.d.ts

@@ -0,0 +1,12 @@
+import { MenuConfig } from '@univerjs/ui';
+import { IImageWatermarkConfig, ITextWatermarkConfig, IUserInfoWatermarkConfig } from '../common/type';
+export declare const PLUGIN_CONFIG_KEY = "watermark.config";
+export declare const configSymbol: unique symbol;
+export interface IUniverWatermarkConfig {
+    menu?: MenuConfig;
+    showMenu?: boolean;
+    userWatermarkSettings?: Partial<IUserInfoWatermarkConfig>;
+    textWatermarkSettings?: Partial<ITextWatermarkConfig>;
+    imageWatermarkSettings?: Partial<IImageWatermarkConfig>;
+}
+export declare const defaultPluginConfig: IUniverWatermarkConfig;

package/lib/types/controllers/menu.d.ts

@@ -0,0 +1,3 @@
+import { IMenuButtonItem } from '@univerjs/ui';
+import { IAccessor } from '@univerjs/core';
+export declare function WatermarkMenuItemFactory(accessor: IAccessor): IMenuButtonItem;

package/lib/types/controllers/menu.schema.d.ts

@@ -0,0 +1,2 @@
+import { MenuSchemaType } from '@univerjs/ui';
+export declare const menuSchema: MenuSchemaType;

package/lib/types/controllers/watermark.menu.controller.d.ts

@@ -0,0 +1,9 @@
+import { Disposable } from '@univerjs/core';
+import { ComponentManager, IMenuManagerService } from '@univerjs/ui';
+export declare class UniverWatermarkMenuController extends Disposable {
+    protected readonly _menuManagerService: IMenuManagerService;
+    private readonly _componentManager;
+    constructor(_menuManagerService: IMenuManagerService, _componentManager: ComponentManager);
+    private _initComponents;
+    private _initMenu;
+}

package/lib/types/controllers/watermark.render.controller.d.ts

@@ -0,0 +1,14 @@
+import { UnitModel, ILocalStorageService, RxDisposable, UserManagerService } from '@univerjs/core';
+import { IRenderContext, IRenderModule } from '@univerjs/engine-render';
+import { WatermarkService } from '../services/watermark.service';
+export declare class WatermarkRenderController extends RxDisposable implements IRenderModule {
+    private readonly _context;
+    private _watermarkService;
+    private _localStorageService;
+    private _userManagerService;
+    private readonly _watermarkLayer;
+    constructor(_context: IRenderContext<UnitModel>, _watermarkService: WatermarkService, _localStorageService: ILocalStorageService, _userManagerService: UserManagerService);
+    private _initAddRender;
+    private _initWatermarkConfig;
+    private _initWatermarkUpdate;
+}

package/lib/types/facade/f-univer.d.ts

@@ -0,0 +1,26 @@
+import { IImageWatermarkConfig, ITextWatermarkConfig, IWatermarkTypeEnum } from '../common/type';
+interface IFUniverWatermarkMixin {
+    /**
+     * Adds a watermark to the unit. Supports both text and image watermarks based on the specified type.
+     *
+     * @param {IWatermarkTypeEnum.Text | IWatermarkTypeEnum.Image} type - The type of watermark to add. Can be either 'Text' or 'Image'.
+     * @param {ITextWatermarkConfig | IImageWatermarkConfig} config - The configuration object for the watermark.
+     * - If the type is 'Text', the config should follow the ITextWatermarkConfig interface.
+     * - If the type is 'Image', the config should follow the IImageWatermarkConfig interface.
+     * @throws {Error} Throws an error if the watermark type is unknown.
+     */
+    addWatermark(type: IWatermarkTypeEnum.Text, config: ITextWatermarkConfig): void;
+    addWatermark(type: IWatermarkTypeEnum.Image, config: IImageWatermarkConfig): void;
+    addWatermark(type: IWatermarkTypeEnum.Text | IWatermarkTypeEnum.Image, config: ITextWatermarkConfig | IImageWatermarkConfig): void;
+    /**
+     * Deletes the currently applied watermark from the unit.
+     *
+     * This function retrieves the watermark service and invokes the method to remove any existing watermark configuration.
+     */
+    deleteWatermark(): void;
+}
+declare module '@univerjs/core' {
+    interface FUniver extends IFUniverWatermarkMixin {
+    }
+}
+export {};

package/lib/types/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 { UniverWatermarkPlugin } from './plugin';
+export { WatermarkImageBaseConfig, WatermarkTextBaseConfig, WatermarkUserInfoBaseConfig } from './common/const';
+export type { IImageWatermarkConfig, ITextWatermarkConfig } from './common/type';
+export { IWatermarkTypeEnum } from './common/type';
+export { WatermarkService } from './services/watermark.service';

package/lib/types/locale/en-US.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/fa-IR.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/ru-RU.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/vi-VN.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/locale/zh-CN.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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.
+ */
+declare const locale: {
+    'univer-watermark': {
+        title: string;
+        type: string;
+        text: string;
+        image: string;
+        uploadImage: string;
+        replaceImage: string;
+        keepRatio: string;
+        width: string;
+        height: string;
+        style: string;
+        content: string;
+        textPlaceholder: string;
+        fontSize: string;
+        direction: string;
+        ltr: string;
+        rtl: string;
+        inherits: string;
+        opacity: string;
+        layout: string;
+        rotate: string;
+        repeat: string;
+        spacingX: string;
+        spacingY: string;
+        startX: string;
+        startY: string;
+        cancel: string;
+        close: string;
+        copy: string;
+    };
+};
+export default locale;

package/lib/types/locale/zh-TW.d.ts

@@ -0,0 +1,3 @@
+import { default as zhCN } from './zh-CN';
+declare const locale: typeof zhCN;
+export default locale;

package/lib/types/plugin.d.ts

@@ -0,0 +1,18 @@
+import { IUniverWatermarkConfig } from './controllers/config.schema';
+import { ICommandService, IConfigService, ILocalStorageService, Injector, Plugin } from '@univerjs/core';
+import { IRenderManagerService } from '@univerjs/engine-render';
+export declare class UniverWatermarkPlugin extends Plugin {
+    private readonly _config;
+    protected _injector: Injector;
+    private readonly _configService;
+    private readonly _commandService;
+    private readonly _renderManagerSrv;
+    private readonly _localStorageService;
+    static pluginName: string;
+    constructor(_config: Partial<IUniverWatermarkConfig> | undefined, _injector: Injector, _configService: IConfigService, _commandService: ICommandService, _renderManagerSrv: IRenderManagerService, _localStorageService: ILocalStorageService);
+    private _initWatermarkStorage;
+    private _initDependencies;
+    private _initRegisterCommand;
+    onRendered(): void;
+    private _initRenderDependencies;
+}

package/lib/types/services/watermark.service.d.ts

@@ -0,0 +1,15 @@
+import { Nullable, Disposable, ILocalStorageService } from '@univerjs/core';
+import { IWatermarkConfigWithType } from '../common/type';
+export declare class WatermarkService extends Disposable {
+    private _localStorageService;
+    private readonly _updateConfig$;
+    readonly updateConfig$: import('rxjs').Observable<Nullable<IWatermarkConfigWithType>>;
+    private readonly _refresh$;
+    readonly refresh$: import('rxjs').Observable<number>;
+    constructor(_localStorageService: ILocalStorageService);
+    getWatermarkConfig(): Promise<IWatermarkConfigWithType | null>;
+    updateWatermarkConfig(config: IWatermarkConfigWithType): void;
+    deleteWatermarkConfig(): void;
+    refresh(): void;
+    dispose(): void;
+}

package/lib/types/util.d.ts

@@ -0,0 +1,7 @@
+import { IUser, Nullable } from '@univerjs/core';
+import { UniverRenderingContext } from '@univerjs/engine-render';
+import { IImageWatermarkConfig, ITextWatermarkConfig, IUserInfoWatermarkConfig, IWatermarkConfigWithType } from './common/type';
+export declare function renderWatermark(ctx: UniverRenderingContext, config: IWatermarkConfigWithType, image: Nullable<HTMLImageElement>, userInfo: Nullable<IUser>): void;
+export declare function renderUserInfoWatermark(ctx: UniverRenderingContext, config: IUserInfoWatermarkConfig, userInfo: Nullable<IUser>): void;
+export declare function renderTextWatermark(ctx: UniverRenderingContext, config: ITextWatermarkConfig): void;
+export declare function renderImageWatermark(ctx: UniverRenderingContext, config: IImageWatermarkConfig, image: Nullable<HTMLImageElement>): void;

package/lib/types/views/components/WatermarkImageSetting.d.ts

@@ -0,0 +1,8 @@
+import { IImageWatermarkConfig } from '../../common/type';
+import { default as React } from 'react';
+interface IWatermarkImageSettingProps {
+    config?: IImageWatermarkConfig;
+    onChange: (config: IImageWatermarkConfig) => void;
+}
+export declare const WatermarkImageSetting: React.FC<IWatermarkImageSettingProps>;
+export {};

package/lib/types/views/components/WatermarkPanel.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare const WatermarkPanel: React.FC;

package/lib/types/views/components/WatermarkPanelFooter.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare const WatermarkPanelFooter: React.FC;

package/lib/types/views/components/WatermarkTextSetting.d.ts

@@ -0,0 +1,8 @@
+import { ITextWatermarkConfig } from '../../common/type';
+import { default as React } from 'react';
+interface IWatermarkTextSettingProps {
+    config?: ITextWatermarkConfig;
+    onChange: (config: ITextWatermarkConfig) => void;
+}
+export declare const WatermarkTextSetting: React.FC<IWatermarkTextSettingProps>;
+export {};

package/lib/types/views/extensions/watermark-layer.d.ts

@@ -0,0 +1,11 @@
+import { IUser } from '@univerjs/core';
+import { UniverRenderingContext, Layer } from '@univerjs/engine-render';
+import { IWatermarkConfigWithType } from '../../common/type';
+export declare class WatermarkLayer extends Layer {
+    private _config;
+    private _image;
+    private _user;
+    render(ctx?: UniverRenderingContext, isMaxLayer?: boolean): this;
+    updateConfig(config?: IWatermarkConfigWithType, user?: IUser): void;
+    private _renderWatermark;
+}