weboffice-js-sdk 2.0.3 → 2.0.4

package/dist/OfficeSDK.d.ts

@@ -0,0 +1,656 @@
+import 'core-js/features/promise';
+import 'core-js/features/url';
+import 'core-js/features/array/includes';
+import 'core-js/features/object/assign';
+import 'proxy-polyfill';
+import { TinyEmitter } from 'tiny-emitter';
+import { ContainerMethod, ContainerRect, DisableMentionCards, FileType, InvokeMethod, MouseMovePayload, ReadyState, PerformanceEntry, DeviceMode, GenerateUrlHandler, APIAdaptor, RequestContext, ShowToastOptions, Credentials } from 'weboffice-js-sdk-shared';
+import { Document, DocumentPro, Presentation, Spreadsheet, Table, Form, Flowchart } from '.';
+import { EmptyPageOptions } from './types/EmptyPage';
+import { BaseEditor } from './types/BaseEditor';
+import { SlashMenuOptions } from './types/SlashMenu';
+import type { CollaboratorFacade, CommentsFacade, ContentFacade, DiscussionFacade, DocsOutlineFacade, DocsSearchFacade, DocsSelectionFacade, DocsSettingsFacade, DocsSidebarFacade, DocsTablesFacade, ExternalAppFacade, HistoryFacade, LocksFacade, MentionFacade, PresentationEventSubscriptionFacade, PresentationFacade, PresentationSelectionFacade, PresentationSlidesFacade, PresentationTextFacade, PresentationZoomFacade, SheetChartsFacade, SheetSelectionsFacade, SheetWorkbookFacade, SheetWorksheetFacade, TitleFacade, VersionFacade } from './OfficeSDK.facade.types';
+import type { HeaderBarsFacade } from './OfficeSDK.headerBars';
+export * from './OfficeSDK.facade.types';
+export * from './OfficeSDK.headerBars';
+export declare const MessageEvent: typeof InvokeMethod;
+export declare class OfficeSDK extends TinyEmitter {
+    /**
+     * 编辑器页面对应的 iframe 元素。需要注意调整父元素大小来控制 iframe 大小。
+     */
+    element: HTMLIFrameElement;
+    readonly uuid: string;
+    readonly userUuid?: string;
+    /**
+     * 传统文档编辑器实例
+     * @deprecated - 用 `sdk.getEditor<T>()` 替代
+     */
+    documentPro?: DocumentPro.Editor;
+    /**
+     * 轻文档编辑器实例
+     * @deprecated - 用 `sdk.getEditor<T>()` 替代
+     */
+    document?: Document.Editor;
+    /**
+     * 表格编辑器实例
+     * @deprecated - 用 `sdk.getEditor<T>()` 替代
+     */
+    spreadsheet?: Spreadsheet.Editor;
+    /**
+     * 当前套件支持的标题能力。
+     */
+    title?: TitleFacade;
+    /**
+     * 当前套件支持的历史能力。
+     */
+    history?: HistoryFacade;
+    /**
+     * 当前套件支持的评论能力。
+     */
+    comments?: CommentsFacade;
+    /**
+     * 当前套件支持的讨论能力。
+     */
+    discussion?: DiscussionFacade;
+    /**
+     * 当前套件支持的编写者侧边栏能力。
+     */
+    collaborator?: CollaboratorFacade;
+    /**
+     * 当前套件支持的第三方应用插入能力。
+     */
+    externalApp?: ExternalAppFacade;
+    /**
+     * 当前套件支持的锁定能力。
+     */
+    locks?: LocksFacade;
+    /**
+     * 当前套件支持的提及定位能力。
+     */
+    mention?: MentionFacade;
+    /**
+     * 当前套件支持的内容写入能力。
+     */
+    content?: ContentFacade;
+    /**
+     * 当前套件支持的版本能力。
+     */
+    version?: VersionFacade;
+    /**
+     * 当前套件支持的演示能力。
+     */
+    presentation?: PresentationFacade;
+    /**
+     * 当前套件支持的选区能力。
+     */
+    selection?: DocsSelectionFacade | PresentationSelectionFacade;
+    /**
+     * 当前套件支持的搜索能力。
+     */
+    search?: DocsSearchFacade;
+    /**
+     * 当前套件支持的目录能力。
+     */
+    outline?: DocsOutlineFacade;
+    /**
+     * 当前套件支持的侧边栏能力。
+     */
+    sidebar?: DocsSidebarFacade;
+    /**
+     * 当前套件支持的表格集合能力。
+     */
+    tables?: DocsTablesFacade;
+    /**
+     * 当前套件支持的设置能力。
+     */
+    settings?: DocsSettingsFacade;
+    /**
+     * 当前套件支持的工作簿能力。
+     */
+    workbook?: SheetWorkbookFacade;
+    /**
+     * 当前套件支持的当前工作表能力。
+     */
+    activeSheet?: SheetWorksheetFacade;
+    /**
+     * 当前套件支持的图表能力。
+     */
+    charts?: SheetChartsFacade;
+    /**
+     * 当前套件支持的多选区能力。
+     */
+    selections?: SheetSelectionsFacade;
+    /**
+     * 当前套件支持的幻灯片集合能力。
+     */
+    slides?: PresentationSlidesFacade;
+    /**
+     * 当前套件支持的文本能力。
+     */
+    text?: PresentationTextFacade;
+    /**
+     * 当前套件支持的缩放能力。
+     */
+    zoom?: PresentationZoomFacade;
+    /**
+     * 当前套件支持的事件订阅能力。
+     */
+    eventSubscription?: PresentationEventSubscriptionFacade;
+    /**
+     * 当前套件支持的批量变更能力。
+     */
+    batchChanges?: <T>(callback: () => T | Promise<T>) => Promise<Awaited<T>>;
+    /**
+     * 当前套件支持的导出能力。
+     */
+    export?: (type: string) => Promise<void>;
+    /**
+     * 当前套件支持的打印能力。
+     */
+    print?: () => Promise<void>;
+    /**
+     * 当前套件支持的聚焦能力。
+     */
+    setFocus?: (isFocus: boolean) => Promise<void>;
+    /**
+     * 应用表格编辑器实例
+     * @deprecated - 用 `sdk.getEditor<T>()` 替代
+     */
+    table?: Table.Editor;
+    /**
+     * 表单编辑器实例
+     * @deprecated - 用 `sdk.getEditor<T>()` 替代
+     */
+    form?: Form.Editor;
+    /**
+     * 图谱编辑器实例
+     * @deprecated - 用 `sdk.getEditor<T>()` 替代
+     */
+    flowchart?: Flowchart.Editor;
+    readonly headerBars: HeaderBarsFacade;
+    private _fileType;
+    private readonly messageHandler;
+    /**
+     * 内部 event emitter，比如用来中转 editor 事件
+     */
+    private readonly emitter;
+    private channel;
+    private readonly connectOptions;
+    private _readyState;
+    private editor;
+    private readonly startParams;
+    private collaborators;
+    private readonly apiAdaptor;
+    private readonly apiAdaptorContext;
+    private readonly handledMessageCache;
+    /**
+     * 消息过期时间，单位毫秒，默认 5 分钟
+     */
+    private readonly messageExpires;
+    /**
+     * SDK 服务器的地址
+     */
+    private readonly endpoint;
+    private readonly sameOrigin;
+    private headerBarsVisible;
+    private readonly headerBarsCommands;
+    private readonly headerBarsCommandOverrides;
+    private readonly slashMenuCallbacks;
+    private readonly editorFacadeCallbacks;
+    private readonly headerBarsCommandRefs;
+    private headerBarsTitleChangeHandler?;
+    private headerBarsTitleChangeSubscribed;
+    private readonly onViewportResize;
+    /**
+     * 归一化后的缺省页配置，构造时一次算完，后续仅读取。
+     */
+    private readonly normalizedEmptyPage;
+    private readonly preloadAckTimeoutMs;
+    private readonly preloadDoneTimeoutMs;
+    private readonly preloadReadyTimeoutMs;
+    constructor(options: OfficeSDKOptions);
+    get fileType(): FileType;
+    get readyState(): ReadyState;
+    /**
+     * 判断当前实例是否应该向 iframe 暴露 slashMenu。
+     * 输入：无，读取当前文件类型与 startParams.type 提示。
+     * 输出：仅在明确是 docs，或尚未拿到文件类型且没有明确非 docs 提示时返回 true。
+     */
+    private shouldExposeSlashMenu;
+    /**
+     * 从 startParams 中提取文件类型提示。
+     * 输入：无。
+     * 输出：标准化后的 type 字符串；若未配置则返回 undefined。
+     */
+    private getSlashMenuTypeHint;
+    /**
+     * 将宿主传入的 slashMenu 转成可跨 iframe 传输的纯数据结构。
+     * 输入：当前实例上的 `OfficeSDKOptions.slashMenu`。
+     * 输出：去除真实函数、附带 callbackId 的 slashMenu 配置；不适用时返回 undefined。
+     */
+    private createSerializedSlashMenu;
+    /**
+     * 递归序列化 slashMenu 菜单项，并登记 button callback。
+     * 输入：菜单项数组与当前递归路径。
+     * 输出：仅包含结构化克隆安全字段的菜单项数组。
+     */
+    private serializeSlashMenuItems;
+    /**
+     * 为 slashMenu button callback 生成稳定 id 并注册到内存表。
+     * 输入：菜单路径与可选 callback。
+     * 输出：注册后的 callbackId；若未提供 callback 则返回 undefined。
+     */
+    private registerSlashMenuCallback;
+    getEditor<T extends BaseEditor | Document.Editor | DocumentPro.Editor | Presentation.Editor | Spreadsheet.Editor | Form.Editor | Flowchart.Editor | Table.Editor = BaseEditor>(): T;
+    /**
+     * 更新鉴权 signature 和 token
+     * @deprecated - 用 `OfficeSDKOptions.getCredentials()` 替代
+     */
+    setCredentials(payload: {
+        signature: string;
+        token: string;
+    }): Promise<void>;
+    /**
+     * 设置石墨的鉴权 signature。用于实时更新鉴权信息，优化用户出现因长时间放置，鉴权失败而引起的体验问题。
+     * @deprecated - 用 `sdk.setCredentials()` 替代
+     */
+    setSignature(signature: string): Promise<void>;
+    /**
+     * 设置您系统的鉴权 token。用于实时更新鉴权信息，优化用户出现因长时间放置，鉴权失败而引起的体验问题。
+     * @deprecated - 用 `sdk.setCredentials()` 替代
+     */
+    setToken(token: string): Promise<void>;
+    /**
+     * 获取性能信息片段列表，由于性能标记是分段的、异步的，因此每次调用时获取的列表有可能不一致
+     */
+    getPerformanceEntries(): Promise<PerformanceEntry[]>;
+    disconnect(): void;
+    /**
+     * 初始化 SDK，返回 Promise，当 ReadState 变为 Ready 或 Failed 时，Promise 将被 resolve。
+     * Promise resovled 不代表编辑器已经完整加载完毕，只代表 SDK 已经准备好了。
+     * 同时 Promise 一直 pending 也不代表编辑器加载失败，只代表无法通过 SDK 和编辑器交互。
+     * 比如受浏览器限制无法发出 postMessage() 时，Promise 将会一直 pending。
+     */
+    init(): Promise<void>;
+    /**
+     * 等待 SDK 进入 Ready 状态。若已 ready，则直接返回。
+     */
+    ready(): Promise<void>;
+    private initIframe;
+    private runPreloadHandshake;
+    private initChannel;
+    /**
+     * 初始化处理编辑器需要容器返回数据的方法
+     */
+    private bindContainerMethodHandlers;
+    private initHeaderBarsFacade;
+    /**
+     * 订阅 iframe 侧 titleChange 事件，并在宿主设置了 headerBars.onTitleChange 时转发标题值。
+     * 输入：无。
+     * 输出：监听建立成功后返回 Promise<void>；重复调用只会订阅一次。
+     */
+    private ensureHeaderBarsTitleChangeSubscription;
+    private invokeHeaderBars;
+    private syncHeaderBarsCommands;
+    private createHeaderBarsHost;
+    private applyHeaderBarsChanged;
+    private syncHeaderBarsVisible;
+    private setHeaderBarsVisible;
+    private getHeaderBarsCommandRef;
+    /**
+     * 注册一个可供 iframe 侧反向调用的 facade callback。
+     * 输入：宿主侧 callback。
+     * 输出：供跨窗协议使用的 callbackId。
+     */
+    private registerEditorFacadeCallback;
+    /**
+     * 注销已注册的 facade callback。
+     * 输入：callbackId。
+     * 输出：无。
+     */
+    private unregisterEditorFacadeCallback;
+    /**
+     * 创建基于 method-path 的模块 facade。
+     * 输入：模块前缀与少量自定义实现覆盖。
+     * 输出：其余方法按 `${prefix}.${method}` 自动桥接。
+     */
+    private createEditorFacadeModule;
+    /**
+     * 为 value-based locator 创建本地对象 facade。
+     * 输入：method-path 前缀、locator 和静态属性。
+     * 输出：支持继续远程调用的本地 facade。
+     */
+    private createValueObjectFacade;
+    /**
+     * 注册一个基于 callback 协议的 listener。
+     * 输入：注册方法名与监听器。
+     * 输出：供宿主侧取消注册的函数。
+     */
+    private registerEditorFacadeListener;
+    private installRootFacade;
+    /**
+     * 重置根级能力命名空间，避免不同套件间字段残留。
+     * 输入：无。
+     * 输出：将所有 facade 字段置空。
+     */
+    private clearRootFacade;
+    /**
+     * 调用显式 editor facade method-path。
+     * 输入：method-path 与参数数组。
+     * 输出：返回 iframe 侧序列化结果。
+     */
+    private invokeEditorFacade;
+    /**
+     * 为结构化 facade 建立 editor 事件监听，并返回取消监听函数。
+     * 输入：事件名与监听器。
+     * 输出：返回一个可取消当前监听的函数。
+     */
+    private listenEditorEvent;
+    private initEditor;
+    private shouldHandleMessage;
+    private getContainerRect;
+    private updateCollaborators;
+}
+/**
+ * 需要容器提供给编辑器使用的方法
+ */
+export interface ContainerMethods {
+    /**
+     * 获取容器尺寸等信息
+     */
+    [ContainerMethod.GetContainerRect]?: () => ContainerRect;
+    /**
+     * 处理石墨文档内点击链接事件
+     */
+    [ContainerMethod.OpenLink]?: (
+    /**
+     * 目标链接
+     */
+    url: string, 
+    /**
+     * 意义和 window.open 的第二个参数一样，属于石墨建议的值，具体是否需要使用请接入方自行判断。
+     */
+    target?: string) => void;
+    /**
+     * 生成插入到石墨文档中的链接，用于处理 @ 文件等功能需要插入的链接
+     */
+    [ContainerMethod.GenerateUrl]?: GenerateUrlHandler;
+    /**
+     * 用于移动端处理 @ 点击事件
+     */
+    [ContainerMethod.MentionClickHandlerForMobile]?: (payload: MouseMovePayload) => void;
+    /**
+     * 用于从客户业务 URL 中获取对应的文件 ID，供编辑器使用。
+     */
+    [ContainerMethod.GetFileInfoFromUrl]?: (url: string) => Promise<{
+        /**
+         * 文件 ID
+         */
+        fileId: string;
+    } | undefined>;
+    /**
+     * 用于显示客户自定义toast。
+     */
+    [ContainerMethod.ShowToast]?: (options: ShowToastOptions) => Promise<void>;
+    /**
+     * 通知用户执行自定义操作，操作由用户自定义按钮触发
+     */
+    [ContainerMethod.HandleCustomTask]?: (taskId: string) => Promise<void>;
+    /**
+     * 请求容器获取鉴权信息
+     * @returns {Credentials} 鉴权信息
+     */
+    [ContainerMethod.GetCredentials]: () => Promise<Credentials>;
+}
+export declare enum Event {
+    /**
+     * SDK 初始化事件，用于内部逻辑
+     */
+    SDKInit = "SDKInit",
+    /**
+     * 错误事件，包含编辑器抛出的错误
+     */
+    Error = "error",
+    /**
+     * OfficeSDK 状态变化事件
+     */
+    ReadyState = "readyState",
+    /**
+     * 编辑器真正完成"首屏渲染"的信号。
+     *
+     * 由 iframe 内编辑器在自身渲染稳定后通过 channel 发送，SDK 侧转发为本事件。
+     * 宿主可按需监听它来区分 SDK Ready 与编辑器视觉首屏完成。
+     */
+    EditorRendered = "editorRendered",
+    /**
+     * 编辑器事件
+     */
+    EditorEvent = "editorEvent"
+}
+/**
+ * iframe 内侧用来上报"编辑器已完成首屏渲染"的 channel 事件名。
+ *
+ * 与 `InvokeMethod.ReadyState` 的枚举值保持在同一命名空间，但不入 shared 包，
+ * 以免跨端版本耦合。iframe 侧约定写字符串即可。
+ */
+export declare const EDITOR_RENDERED_EVENT = "editorRendered";
+export interface Message {
+    uuid?: string;
+    event: string;
+    body: any;
+    error?: Error;
+}
+export interface MessageEventPayload {
+    event: InvokeMethod;
+    data: unknown[];
+}
+export interface ContainerMethodPayload {
+    method: ContainerMethod;
+    args: unknown[];
+}
+export interface ReadyStateEvent {
+    state: ReadyState;
+    fileType: FileType;
+    error?: Error | string;
+}
+/**
+ * 事件回调函数
+ */
+export type EventCallback = (...args: any[]) => any;
+/**
+ * SDK toast 文案配置，值仅允许字符串或嵌套对象。
+ */
+export interface SDKToastOptions {
+    [key: string]: string | SDKToastOptions | undefined;
+}
+/**
+ * 透传给 iframe 编辑器的主题配置。
+ * 当前 shimo-js-sdk 仅负责跨 iframe 传输，不在宿主侧约束字段细节。
+ */
+export interface CommonThemeConfig {
+    [key: string]: unknown;
+}
+/**
+ * iframe 内置加载页配置，只支持可序列化字段。
+ */
+export interface LoadingOptions {
+    /**
+     * 自定义加载页 Logo。传字符串时作为图片 URL / dataURL 使用；
+     * 传 false 时隐藏 Logo；不传时使用 iframe 内默认石墨 Logo。
+     */
+    logo?: string | false;
+    /**
+     * 自定义加载页提示文案。不传时使用 iframe 内默认文案。
+     */
+    tip?: string;
+}
+/**
+ * OfficeSDK 初始化参数
+ */
+export interface OfficeSDKOptions extends Omit<ContainerMethods, 'getContainerRect'> {
+    /**
+     * 石墨 SDK 服务器地址
+     */
+    endpoint: string;
+    /**
+     * 您要打开的文档 ID
+     */
+    fileId: string;
+    /**
+     * 用于石墨 SDK 鉴权用的签名
+     */
+    signature: string;
+    /**
+     * iframe 挂载的目标容器
+     */
+    container: HTMLElement;
+    /**
+     * 用于您系统鉴权使用的 token
+     */
+    token: string;
+    /**
+     * 刷新鉴权信息的间隔时间，单位为毫秒
+     */
+    refreshCredentialsInterval: number;
+    /**
+     * 添加到 iframe URLSearchParams 的参数列表
+     */
+    params?: {
+        [key: string]: string;
+    };
+    /**
+     * 当前打开模式。`preview` 用于预览态，其余场景默认按 `edit` 处理。
+     */
+    mode?: 'edit' | 'preview';
+    /**
+     * 石墨 SDK URL 参数 url?smParams={params}，用于传递石墨 SDK 内部需要的参数。
+     */
+    smParams?: string | Record<string, unknown> | Array<string | Record<string, unknown>>;
+    /**
+     * 指定石墨 SDK 编辑器界面语言，添加到 iframe URLSearchParams 的参数列表。
+     * 若未指定，则 iframe 使用服务器设置的默认语言。
+     *
+     * 目前支持的标准语言取值：
+     * 1. zh-CN（简体中文）
+     * 2. zh-TW（繁体中文）
+     * 3. en-US（英文）
+     * 4. ja-JP（日文）
+     * 5. ko-KR（韩文）
+     * 6. es-ES（西班牙语）
+     * 7. pt-PT（葡萄牙语）
+     * 8. de-DE（德语）
+     * 9. fr-FR（法语）
+     * 10. it-IT（意大利语）
+     * 11. ru-RU（俄语）
+     * 12. id-ID（印尼语）
+     * 13. vi-VN（越南语）
+     * 14. th-TH（泰语）
+     * 15. ms-MY（马来语）
+     * 16. ar-SA（阿拉伯语）
+     *
+     * 为兼容旧版写法，仍接受 en、ja，传入后会自动映射为 en-US、ja-JP。
+     */
+    lang?: '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' | 'en' | 'ja';
+    /**
+     * 是否禁用提及的浮动卡片组件
+     */
+    disableMentionCards?: DisableMentionCards;
+    /**
+     * 用于覆盖编辑器内部分 toast 文案。
+     * 支持套件类型：form、documentPro、presentation、spreadsheet、table（仅对支持 ui 配置的套件生效）。
+     * 当前已文档化支持字段：ui.toast.tips.edit.noPermission。
+     * 其他字段暂不作为稳定公共 API 承诺。
+     */
+    ui?: {
+        toast?: SDKToastOptions;
+    };
+    /**
+     * 用于控制 iframe feature policy (https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Feature-Policy) 。
+     * 会覆盖默认的 policy，因此使用时需要注意把需要的 policy 写完整。
+     */
+    allowPolicy?: string;
+    /**
+     * 是否开启调试模式，true 会通过 console 打印一些信息
+     */
+    debug?: boolean;
+    /**
+     * 编辑器插件配置，不是所有类型的套件都支持，以套件是否提供 PluginOptions 为准
+     */
+    plugins?: Spreadsheet.PluginOptions | Table.PluginOptions;
+    /**
+     * iframe postMessage 的目标 origin，默认是当前页面的 location.origin。
+     * @deprecated
+     */
+    targetOrigin?: string;
+    /**
+     * 使用什么设备类型模式，会直接影响功能和样式，不传值或空字符串则默认用 user-agent 自动判断。受版本限制，不是所有类型都支持。
+     */
+    deviceMode?: DeviceMode;
+    /**
+     * 是否禁用默认的签名组件，以支持自定义签名组件。受版本限制，部分版本的特定类型文档才支持。
+     */
+    disableSignatureComponent?: boolean;
+    /**
+     * 控制 headerbar 组件是否展示，false 表示隐藏。
+     */
+    headerBarsVisible?: boolean;
+    /**
+     * 是否隐藏 iframe 内 AI 入口。
+     * 对应 iframe 内 ShimoSDK 的现有 AI 入口开关能力。
+     */
+    disableAiEntry?: boolean;
+    /**
+     * 编辑器主题配置。
+     * 该参数会透传到 iframe 内各套件初始化链路；未传时保持 iframe 默认主题。
+     */
+    theme?: CommonThemeConfig;
+    /**
+     * docs 斜杠菜单配置。
+     * 仅 docs 文件类型生效；`button.callback` 实际运行在宿主页，
+     * 会在 iframe 内点击菜单按钮后通过 postMessage/channel 回调触发。
+     */
+    slashMenu?: SlashMenuOptions;
+    /**
+     * 是否显示内置的加载动画，只在静态资源加载到编辑器渲染这个阶段显示
+     */
+    showLoadingEffect?: boolean;
+    /**
+     * 是否启用 iframe 内置默认加载页，默认 false。
+     * 隐藏后接入方可自定义外部 loading。
+     */
+    showLoading?: boolean;
+    /**
+     * iframe 内置加载页配置。仅在 `showLoading === true`
+     * 或 `showLoadingEffect === true` 时透传给 iframe。
+     */
+    loadingOptions?: LoadingOptions;
+    /**
+     * 用于在编辑器发起 API 请求时，对请求参数进行修改的函数。详细用法见文档。
+     */
+    apiAdaptor?: APIAdaptor;
+    /**
+     * 用于在编辑器发起 API 请求时，对请求参数进行修改的函数时传入的上下文数据。
+     */
+    apiAdaptorContext?: RequestContext;
+    /**
+     * 用于判断通信消息过期时间，过期后的消息会被抛弃，默认 5 分钟。
+     */
+    messageExpires?: number;
+    /**
+     * 加密后的用户id
+     */
+    userUuid?: string;
+    /**
+     * 缺省页（Empty Page）配置。
+     * - 不传或传 `true`：启用默认缺省页能力（有内置图片与默认文案，**无按钮**）
+     * - 传 `false`：完全关闭
+     * - 传对象：精细控制启用的 scene、token 过期策略，以及每个 scene 的
+     *   文案/按钮自定义（`overrides`）。默认不渲染任何按钮，宿主需要按钮时必须
+     *   在 `overrides[scene].primary/secondary` 里显式配置 label，点击统一触发
+     *   `emptyPageAction` 事件由宿主处理。
+     *
+     * 相关事件：`emptyPageShown` / `emptyPageAction` / `emptyPageHidden`。
+     * 详见 `./types/EmptyPage.ts`。
+     */
+    emptyPage?: boolean | EmptyPageOptions;
+}

package/dist/OfficeSDK.facade.d.ts

@@ -0,0 +1,15 @@
+import { FileType } from 'weboffice-js-sdk-shared';
+import type { OfficeSDKRootFacadeState } from './OfficeSDK.facade.types';
+type EditorFacadeCallback = (...args: unknown[]) => unknown | Promise<unknown>;
+interface FacadeHost {
+    fileType: FileType;
+    invokeEditorFacade<T>(method: string, args?: unknown[]): Promise<T>;
+    listenEditorEvent<T>(event: string, listener: (payload: T) => void): () => void;
+    createEditorFacadeModule<T extends object>(prefix: string, staticFields?: Partial<T>): T;
+    createValueObjectFacade<T extends object>(prefix: string, locator: Record<string, unknown>, staticFields: Partial<T>): T;
+    registerEditorFacadeListener<T>(method: string, listener: (payload: T) => void): () => void;
+    registerEditorFacadeCallback(callback: EditorFacadeCallback): string;
+    unregisterEditorFacadeCallback(callbackId: string): void;
+}
+export declare function buildRootFacadeState(host: FacadeHost): OfficeSDKRootFacadeState;
+export {};