@officesdk/editor-sdk-core 0.0.0-alpha.9 → 0.0.1

package/types/docx.d.ts

@@ -54,6 +54,20 @@ export declare abstract class AbstractedDocxSDK extends EditorSDK {
     abstract get paragraphs(): DocxParagraphs;
 }
 
+/**
+ * 编辑文件检查器
+ */
+export declare abstract class AbstractedEditorFileChecker {
+    /**
+     * 检查文件是否符合限制
+     * @param files
+     * @returns 返回符合的files
+     */
+    check?: (files: EditorPickedFile[], options?: {
+        type: 'image' | 'video' | 'audio' | 'attachment';
+    }) => EditorPickedFile[];
+}
+
 export declare abstract class AbstractedEditorFileUploader {
     /**
      * 开始上传
@@ -402,6 +416,8 @@ export declare interface CommonThemeConfig {
         checkbox: CheckboxConfig;
         /** 下拉框 */
         dropdown: DropdownConfig;
+        /** 下拉框按钮 */
+        dropdownButton: DropdownButtonConfig;
         /** 菜单 */
         menu: MenuConfig;
         /** 开关 */
@@ -976,7 +992,7 @@ export declare interface DocxSDKOptions extends EditorOptions {
     /**
      * 主题字体相关配置
      */
-    theme: DocxThemeOptions;
+    theme?: DocxThemeOptions;
     /**
      * 工具栏设置
      */
@@ -1332,7 +1348,7 @@ export declare interface DocxThemeStyleConfigList {
 /**
  * 主题样式配置项
  */
-export declare type DocxThemeStyleKeys = 'BackgroundColor' | 'WebViewBgColor' | 'RulerSize' | 'ScrollWidthInPx' | 'RulerNumber' | 'RulerOutlines' | 'RulerTickMark' | 'RulerMarkersOutline' | 'RulerActiveMarkersOutline' | 'RulerMarkersFill' | 'RulerLightClr' | 'RulerDarkClr' | 'BackgroundScroll' | 'ContentControlBackground' | 'ContentControlTagBackground' | 'ContentControlTagBorder' | 'ContentControllersBrd' | 'ContentControllersHover' | 'ContentControllersActive' | 'ContentControllersText' | 'ContentControllersTextActive' | 'ContentControllersSymbol' | 'ContentControllersSymbolActive' | 'ContentControllersAnchorActive' | 'PageSpace' | 'PageShadowOffsetX' | 'PageShadowOffsetY' | 'PageShadowSize' | 'PageShadowColor' | 'DocumentBottomSpace' | 'DocumentMargins' | 'ToastOffsetTop' | 'ShowTopShadow';
+export declare type DocxThemeStyleKeys = 'BackgroundColor' | 'WebViewBgColor' | 'RulerSize' | 'ScrollWidthInPx' | 'RulerNumber' | 'RulerOutlines' | 'RulerTickMark' | 'RulerMarkersOutline' | 'RulerActiveMarkersOutline' | 'RulerMarkersFill' | 'RulerLightClr' | 'RulerDarkClr' | 'BackgroundScroll' | 'ContentControlBackground' | 'ContentControlTagBackground' | 'ContentControlTagBorder' | 'ContentControllersBrd' | 'ContentControllersHover' | 'ContentControllersActive' | 'ContentControllersText' | 'ContentControllersTextActive' | 'ContentControllersSymbol' | 'ContentControllersSymbolActive' | 'ContentControllersAnchorActive' | 'PageSpace' | 'PageShadowOffsetX' | 'PageShadowOffsetY' | 'PageShadowSize' | 'PageShadowColor' | 'DocumentBottomSpace' | 'DocumentMargins' | 'ToastOffsetTop' | 'ShowTopShadow' | 'ToolbarBackgroundColor' | 'MenuBarBackgroundColor' | 'StatusBarBackgroundColor' | 'SideBarBackgroundColor';
 
 /**
  * 通用目录项条目
@@ -1818,6 +1834,10 @@ export declare interface DropdownButtonConfig {
     color: StateStyles;
     /** 背景 */
     background: StateStyles;
+    /** 无边框背景 */
+    frameLessBackground: StateStyles;
+    /** 边框颜色 */
+    borderColor: StateStyles;
     /** 图标 */
     icon: {
         size: IconSize;
@@ -1837,6 +1857,8 @@ export declare interface DropdownButtonConfig {
         large: DropdownButtonSizeStyles;
         /** 中尺寸 */
         medium: DropdownButtonSizeStyles;
+        /** 小尺寸 */
+        small: DropdownButtonSizeStyles;
     };
 }
 
@@ -1846,6 +1868,7 @@ export declare interface DropdownButtonSizeStyles {
     fontSize: string;
     height: string;
     gap: string;
+    borderRadius: string;
     iconSize: IconSize;
     indicatorSize: IconSize;
 }
@@ -2082,6 +2105,10 @@ export declare interface EditorAttachmentOptions {
      * 附件选择器
      */
     picker?: EditorFilePicker;
+    /**
+     * 文件检查器
+     */
+    checker?: AbstractedEditorFileChecker;
     /**
      * 附件上传器
      */
@@ -2514,6 +2541,14 @@ export declare type EditorContextMenuOptions<TName extends string> = EditorMenuO
  */
 export declare type EditorCopyOptions = EditorLogicFeatureConfig;
 
+/**
+ * 日期格式
+ * - `YYYY/MM/DD` 年/月/日（简繁中文、韩语、日语默认）
+ * - `MM/DD/YYYY` 月/日/年（英语默认）
+ * - `DD/MM/YYYY` 日/月/年（其他语言默认）
+ */
+export declare type EditorDateFormat = 'YYYY/MM/DD' | 'MM/DD/YYYY' | 'DD/MM/YYYY';
+
 /**
  * 编辑器解密选项接口
  * 用于配置编辑器中需要解密的内容的相关选项
@@ -2691,11 +2726,31 @@ export declare interface EditorFilePicker {
 }
 
 export declare interface EditorFilePickerOpenOptions {
+    /**
+     * 文件类型限制
+     */
     mimeTypes?: string[];
+    /**
+     * 最大文件尺寸限制
+     */
     maxSize?: number;
+    /**
+     * 文件后缀限制
+     */
     extensions?: string[];
+    /**
+     * 是否支持多选
+     */
     multiple?: boolean;
+    /**
+     * 是否为选择文件夹
+     */
     directory?: boolean;
+    /**
+     * 文件选择器接受的文件类型，如 'image/*' 表示接受所有图片文件
+     * 如果指定了该配置，则不会再由extensions生成accept
+     */
+    accept?: string;
 }
 
 export declare interface EditorFollowMode {
@@ -2808,9 +2863,32 @@ export declare interface EditorFontsOptions {
      */
     list?: EditorFontsList;
     /**
-     * 是否只使用本地字体，如果为 true，则不会从服务器获取字体列表。
+     * 字体列表中隐藏不可用的字体，包含外部传入的以及各套件内置的字体
+     * 不可用的定义：非本地已安装且不支持下载
+     */
+    hideUnavailableFonts?: boolean;
+    /**
+     * 字体下载监听器注册函数，当字体状态发生变化时调用提供的回调函数。
+     * 回调函数暂时没有参数，后续可以根据需要添加参数，例如提供变化的字体信息等。
+     * @param listener
+     * @returns
+     */
+    registerFontLoadListener?: (listener: (options: FontLoadListenerOptions) => void) => void;
+    /**
+     * 下载字体的函数，接受字体族名称和一个可选的配置对象作为参数。
+     * 配置对象可以包含以下回调函数：
+     * - onProgress: 在下载过程中调用，提供下载进度（0 到 1 之间的数字）。
+     * - onComplete: 在下载完成时调用。
+     * - onError: 在下载过程中发生错误时调用，提供错误对象。
+     * @param fontFamily
+     * @param option
+     * @returns
      */
-    useLocalFontsOnly?: boolean;
+    download?: (fontFamily: string, option?: {
+        onProgress?: (progress: number) => void;
+        onComplete?: () => void;
+        onError?: (error: Error) => void;
+    }) => void;
 }
 
 /**
@@ -2838,20 +2916,61 @@ export declare interface EditorHistory {
     hide: () => void;
 }
 
-export declare type EditorHistoryOptions = EditorFeatureConfig;
+export declare interface EditorHistoryLimitations {
+    /** 单个文件可还原的最近历史记录数量 */
+    getHistoryLimitRevertNum?: () => number | undefined;
+    /** 文件历史保留天数 */
+    getHistoryLimitAllTime?: () => number | undefined;
+}
+
+export declare type EditorHistoryOptions = EditorFeatureConfig & {
+    limitations?: EditorHistoryLimitations;
+};
 
 /**
  * i18n 相关设置
  */
 export declare interface EditorI18nOptions {
     /**
-     * 语言，默认使用浏览器当前环境中的语言
+     * 语言代码
+     * 默认读取浏览器/设备语言并在支持的列表中匹配
+     * 匹配规则：优先精确匹配，其次模糊匹配 language 部分，Fallback 为 en-US
      */
-    language?: string;
+    language?: EditorLanguage;
     /**
      * 文本方向，默认根据语言自动适配
      */
     direction?: 'ltr' | 'rtl';
+    /**
+     * 时区设置（包含 ID、偏移量、标签）
+     * 默认读取浏览器/设备时区，如无法匹配则根据语言推测
+     * Fallback 为 { id: 'Europe/London', offset: 0, label: 'London' }
+     */
+    timezone?: EditorTimezoneInfo;
+    /**
+     * 日期格式
+     * 默认根据语言自动匹配：
+     * - 简繁中文、韩语、日语：YYYY/MM/DD
+     * - 英语：MM/DD/YYYY
+     * - 其他语言：DD/MM/YYYY
+     * 用户手动设置后将保存并优先使用用户设置
+     */
+    dateFormat?: EditorDateFormat;
+    /**
+     * 时间格式
+     * 默认使用 24 小时制
+     * 注意：部分语言（如德语、法语、意大利语、俄语）不支持 12 小时制
+     * 用户手动设置后将保存并优先使用用户设置
+     */
+    timeFormat?: EditorTimeFormat;
+    /**
+     * 周起始日
+     * 默认根据语言自动匹配：
+     * - 英语、阿拉伯语：星期日
+     * - 其他语言：星期一
+     * 用户手动设置后将保存并优先使用用户设置
+     */
+    weekStartDay?: EditorWeekStartDay;
 }
 
 export declare type EditorImageCropPoint = 'nw' | 'north' | 'ne' | 'west' | 'center' | 'east' | 'sw' | 'south' | 'se';
@@ -2896,6 +3015,27 @@ export declare interface EditorImportOptions {
     }>;
 }
 
+/**
+ * 支持的语言代码
+ * - `zh-CN` 简体中文
+ * - `zh-TW` 繁体中文（含 zh-HK, zh-MO）
+ * - `en-US` 英语
+ * - `ja-JP` 日语
+ * - `ko-KR` 韩语
+ * - `es-ES` 西班牙语
+ * - `pt-PT` 葡萄牙语
+ * - `de-DE` 德语
+ * - `fr-FR` 法语
+ * - `it-IT` 意大利语
+ * - `ru-RU` 俄语
+ * - `id-ID` 印度尼西亚语
+ * - `vi-VN` 越南语
+ * - `th-TH` 泰语
+ * - `ms-MY` 马来语
+ * - `ar-SA` 阿拉伯语
+ */
+export declare type EditorLanguage = 'zh-CN' | 'zh-TW' | 'en-US' | 'ja-JP' | 'ko-KR' | 'es-ES' | 'pt-PT' | 'de-DE' | 'fr-FR' | 'it-IT' | 'ru-RU' | 'id-ID' | 'vi-VN' | 'th-TH' | 'ms-MY' | 'ar-SA';
+
 /**
  * 链接配置，抽象打开链接等操作
  */
@@ -3445,7 +3585,11 @@ export declare interface EditorOptions {
     /**
      * 编辑器主题相关设置
      */
-    theme: EditorThemeOptions;
+    theme?: EditorThemeOptions;
+    /**
+     * 编辑器拼写检查相关设置
+     */
+    spellCheck?: EditorSpellCheckOptions;
 }
 
 /**
@@ -3765,6 +3909,49 @@ export declare interface EditorSocket {
     connected: boolean;
 }
 
+export declare interface EditorSpellCheckDictionaryFileConfig {
+    /** 词典文件的 aff 文件路径 */
+    aff: string;
+    /** 词典文件的 dic 文件路径 */
+    dic: string;
+}
+
+/**
+ * 拼写检查相关配置
+ */
+export declare interface EditorSpellCheckOptions extends EditorFeatureConfig {
+    /**
+     * 拼写检查功能配置
+     */
+    spellCheck?: {
+        /**
+         * 拼写检查功能是否被禁用
+         */
+        disabled?: boolean;
+        /**
+         * 拼写检查所需要的字典文件 CDN 域名
+         */
+        dictionaryCDNHost?: string;
+        /**
+         * 自定义拼写检查词典, 用于覆盖内置的默认词典
+         */
+        customDictionary?: Partial<Record<EditorLanguage, EditorSpellCheckDictionaryFileConfig>>;
+    };
+    /**
+     * 语法检查功能配置
+     */
+    grammarCheck?: {
+        /**
+         * 语法检查功能是否被禁用
+         */
+        disabled?: boolean;
+        /**
+         * 拼写检查API的URL,必须使用绝对路径
+         */
+        url?: string;
+    };
+}
+
 /**
  * 编辑器在 `standard` 模式下的权限模式
  * - `editor` 编辑模式
@@ -3907,6 +4094,59 @@ export declare interface EditorThemeOptions<TExtensions = object> extends Common
     extensions?: TExtensions;
 }
 
+/**
+ * 时间格式
+ * - `24h` 24 小时制（默认）
+ * - `12h` 12 小时制（部分语言不支持）
+ */
+export declare type EditorTimeFormat = '24h' | '12h';
+
+/**
+ * 支持的时区 IANA ID
+ *
+ * 覆盖范围: UTC-12 到 UTC+12，共 34 个全球主要城市时区
+ *
+ * 注意事项:
+ * - 所有时区 ID 均为 IANA 时区数据库标准标识符
+ * - Etc/GMT+12 表示 UTC-12（Etc/GMT 时区符号与 UTC 相反）
+ * - 不包括已弃用或非标准时区标识符
+ *
+ * @see https://www.iana.org/time-zones
+ */
+export declare type EditorTimezoneId = 'Etc/GMT+12' | 'Pacific/Pago_Pago' | 'Pacific/Honolulu' | 'America/Anchorage' | 'America/Los_Angeles' | 'America/Denver' | 'America/Mexico_City' | 'America/New_York' | 'America/Santiago' | 'America/Sao_Paulo' | 'Atlantic/South_Georgia' | 'Atlantic/Cape_Verde' | 'Europe/London' | 'Europe/Lisbon' | 'Europe/Paris' | 'Europe/Berlin' | 'Europe/Rome' | 'Europe/Madrid' | 'Africa/Cairo' | 'Europe/Moscow' | 'Asia/Riyadh' | 'Asia/Dubai' | 'Asia/Karachi' | 'Asia/Dhaka' | 'Asia/Bangkok' | 'Asia/Jakarta' | 'Asia/Ho_Chi_Minh' | 'Asia/Shanghai' | 'Asia/Kuala_Lumpur' | 'Asia/Tokyo' | 'Asia/Seoul' | 'Australia/Sydney' | 'Pacific/Guadalcanal' | 'Pacific/Auckland';
+
+/**
+ * 时区信息
+ */
+export declare interface EditorTimezoneInfo {
+    /**
+     * IANA 时区 ID
+     *
+     * 标准的 IANA 时区数据库标识符
+     *
+     * @example 'Asia/Shanghai', 'America/New_York', 'Europe/London'
+     */
+    id: EditorTimezoneId;
+    /**
+     * UTC 偏移量（小时，标准时间）
+     *
+     * - 正数：东半球，如 `8` 表示 UTC+8（北京）
+     * - 负数：西半球，如 `-5` 表示 UTC-5（纽约标准时间）
+     * - 零：格林威治标准时间
+     *
+     * 注意：此值为标准时间，不包含夏令时调整
+     */
+    offset: number;
+    /**
+     * 时区标签（英文）
+     *
+     * 用于 UI 显示的城市或地区名称
+     *
+     * @example 'Shanghai', 'New York', 'London'
+     */
+    label: string;
+}
+
 /**
  * 工具栏功能按钮配置(包括内置按钮和自定义按钮)
  */
@@ -3970,6 +4210,16 @@ export declare interface EditorToolbarOptions<TName extends string> {
      * 如果不配置则按照套件的默认方式挂载。
      */
     container?: HTMLElement;
+    /**
+     * 工具栏样式
+     * 各套件可自行扩展，目前支持背景色配置
+     */
+    style?: {
+        /**
+         * 背景色
+         */
+        backgroundColor?: string;
+    };
 }
 
 /**
@@ -4183,9 +4433,11 @@ export declare interface EditorUserOptions {
 export declare interface EditorVersion {
     /**
      * 保存版本
-     * @param name 版本名称
+     * @param options 版本名称
      */
-    createRevision: (name?: string) => void;
+    createRevision: (options?: string | {
+        name: string;
+    }) => void;
     /**
      * 显示版本(侧边栏或其他形式)
      * 区别于历史侧边栏，在应用表格里表现为打开历史侧边栏切换到版本 tab
@@ -4198,7 +4450,14 @@ export declare interface EditorVersion {
     hide?: () => void;
 }
 
-export declare type EditorVersionOptions = EditorFeatureConfig;
+export declare interface EditorVersionLimitations {
+    /** 单个文件可保存/还原的版本（快照）数量 */
+    getHistoryLimitVersionNum?: () => number | undefined;
+}
+
+export declare type EditorVersionOptions = EditorFeatureConfig & {
+    limitations?: EditorVersionLimitations;
+};
 
 /**
  * 编辑器外部水印信息
@@ -4228,6 +4487,13 @@ export declare type EditorWatermarkResource = {
     url: string;
 };
 
+/**
+ * 周起始日
+ * - `sunday` 星期日（英语、阿拉伯语默认）
+ * - `monday` 星期一（其他语言默认）
+ */
+export declare type EditorWeekStartDay = 'sunday' | 'monday';
+
 export declare interface FileLinkParams {
     /**
      * 文件guid
@@ -4299,6 +4565,35 @@ export declare interface FontFamilyConfig {
     base: string;
 }
 
+/**
+ * 字体下载事件类型
+ */
+export declare enum FontLoadEventType {
+    DownloadStart = "downloadStart",
+    DownloadProgress = "downloadProgress",
+    DownloadComplete = "downloadComplete",
+    DownloadError = "downloadError"
+}
+
+/**
+ * 字体下载事件监听器参数，根据事件类型提供不同的属性
+ */
+export declare type FontLoadListenerOptions = {
+    type: FontLoadEventType.DownloadStart;
+    id: string;
+} | {
+    type: FontLoadEventType.DownloadComplete;
+    id: string;
+} | {
+    type: FontLoadEventType.DownloadProgress;
+    id: string;
+    progress: number;
+} | {
+    type: FontLoadEventType.DownloadError;
+    id: string;
+    error: Error;
+};
+
 /** 字号配置 */
 export declare interface FontSizeConfig {
     /** 超小字号 */
@@ -4433,6 +4728,16 @@ export declare interface HTTPProxy {
      * @returns
      */
     create: (id: string) => Promise<HTTPProxy>;
+    /**
+     * 凭证更新器，用于套件内部主动发起更新凭证操作
+     * 例如：页面可见性发生变化时，在pull请求发起之前
+     */
+    credentials?: {
+        /**
+         * 更新凭证
+         */
+        update: () => Promise<void>;
+    };
 }
 
 /**
@@ -4632,6 +4937,8 @@ export declare interface InputStateColorStyles {
     textColorNormal: string;
     /** 禁用文字颜色 */
     textColorDisabled: string;
+    /** 只读文字颜色 */
+    textColorReadOnly: string;
 }
 
 /** Input 状态样式配置 */
@@ -4718,8 +5025,15 @@ export declare interface MentionInfo {
 export declare interface MenuConfig {
     /** 菜单项配置 */
     menuItem: MenuItemConfig;
+    /** 子菜单 */
+    subMenu: {
+        /** 子菜单弹出位置偏移 */
+        popupOffset: number[];
+    };
     /** 边框 */
     border: BorderConfig;
+    /** 阴影 */
+    boxShadow: Pick<StateStyles, 'normal' | 'hover'>;
     /** 分割线 */
     divider: {
         background: string;
@@ -4743,6 +5057,8 @@ export declare interface MenuItemConfig {
         active: string;
         disabled: string;
     };
+    /** 边框 */
+    border: BorderConfig;
     /** 布局 */
     layout: {
         /** 内边距 */
@@ -4774,6 +5090,8 @@ export declare interface MenuItemConfig {
     };
     /** 尺寸 */
     size: {
+        /** 小尺寸 */
+        small: MenuItemSizeStyles;
         /** 中尺寸 */
         medium: MenuItemSizeStyles;
         /** 大尺寸 */
@@ -5046,6 +5364,7 @@ export declare interface SliderSizeStyles {
     thumbSize: string;
     /** 滑块偏移（距离边缘的间距） */
     thumbOffset: string;
+    borderWidth: string;
 }
 
 /** Slider 滑块（圆点）样式 */
@@ -5060,6 +5379,8 @@ export declare interface SliderTrackStyles {
     backgroundDisabled: string;
     /** 已填充部分背景 */
     filledBackground: string;
+    /** 已填充部分禁用状态背景 */
+    filledBackgroundDisabled: string;
     /** 高度 */
     height: string;
     /** 宽度 */
@@ -5213,7 +5534,18 @@ export declare interface SyncStatusDelegation {
 /** Tab 完整配置 */
 export declare interface TabConfig {
     /** 线性标签页（仅下边框） */
-    line: TabVariantStyles;
+    line: {
+        backgroundColor: string;
+        item: TabStateStyles & {
+            /** 选中底部线条宽度/高度 */
+            bottomActiveWidth: string;
+            /** 选中底部线条圆角 */
+            bottomActiveBorderRadius: string;
+            /** 选中底部线条背景颜色 */
+            bottomActiveBackgroundColor: string;
+        };
+        layout: TabLayoutStyles;
+    };
     /** 面性标签页（带所有边框） */
     card: TabVariantStyles;
     /** 大尺寸配置 */
@@ -5237,8 +5569,10 @@ export declare interface TabStateStyles extends BackgroundStateStyles, BorderSta
 export declare interface TabVariantStyles {
     /** Tab 项状态样式 */
     item: TabStateStyles;
-    /** 布局样式 */
+    /** 布局 */
     layout: TabLayoutStyles;
+    /** tab条背景颜色 */
+    backgroundColor: string;
 }
 
 /** Text Button 变体配置（在基础变体上扩展带背景色的引导样式） */
@@ -5319,6 +5653,10 @@ export declare interface ToastConfig extends ToastBaseStyles {
     error: ToastVariantStyles;
     /** 警告提示样式 */
     warn: ToastVariantStyles;
+    /** 严重警告样式 */
+    critical: ToastVariantStyles;
+    /** 加载提示样式 */
+    loading: ToastVariantStyles;
     /** 偏移量 */
     offset: {
         /** 垂直偏移量 */
@@ -5326,6 +5664,10 @@ export declare interface ToastConfig extends ToastBaseStyles {
         /** 水平偏移量 */
         horizontal: string;
     };
+    /** 关闭按钮 */
+    closeButton: {
+        icon: Pick<IconConfig, 'url'>;
+    };
 }
 
 /**
@@ -5397,6 +5739,11 @@ export declare interface ToastVariantStyles {
     borderColor: string;
     /** 图标配置 */
     icon: IconConfig;
+    /** 消息 */
+    message: {
+        /** 颜色 */
+        color: string;
+    };
 }
 
 /** ToolbarButton 背景状态样式 */
@@ -5442,6 +5789,8 @@ export declare interface ToolbarButtonLayout {
     padding: string;
     /** 整体高度 */
     height: string;
+    /** 整体圆角 */
+    borderRadius: string;
     /** 内容布局 */
     content: {
         padding: string;
@@ -5536,6 +5885,8 @@ export declare interface TooltipStyleConfig {
     lineHeight: string;
     /** 字重 */
     fontWeight: number;
+    /** 最大宽度 */
+    maxWidth?: string;
 }
 
 /** Tooltip White 风格配置 */