weboffice-js-sdk 2.0.3-beta.6 → 2.0.3-beta.8

package/dist/OfficeSDK.d.ts

@@ -28,19 +28,59 @@ export interface HeaderBarsCommandRef {
     readonly id: string;
     visible: boolean;
     disabled: boolean;
+    src?: string;
+    label?: string;
     editable?: boolean;
     onCommandClick?: () => void | Promise<void>;
     getState: () => HeaderBarsCommandState | undefined;
 }
+export type HeaderBarsTitleChangeHandler = (title: string) => void | Promise<void>;
 export interface HeaderBarsFacade {
     visible: boolean;
+    onTitleChange?: HeaderBarsTitleChangeHandler;
     getVisible: () => Promise<boolean>;
     setVisible: (visible: boolean) => Promise<void>;
     addCommand: (command: HeaderBarsCommandDefinition, posCommand: string, pos?: 'before' | 'after') => Promise<boolean>;
     getCommand: (id: string) => HeaderBarsCommandRef;
     listViewCommands: () => Promise<HeaderBarsCommandState[]>;
-    setTitleDraft: (title: string) => Promise<void>;
-    confirmTitleChange: (title: string) => Promise<void>;
+}
+export interface TitleFacade {
+    addChangedListener: (listener: (title: string) => void) => () => void;
+    setTitle: (title: string) => Promise<void>;
+}
+export interface CommentsFacade {
+    show: (type?: 'list' | 'card') => Promise<void>;
+    hide: (type?: 'list' | 'card') => Promise<void>;
+}
+export interface HistoryFacade {
+    show: () => Promise<void>;
+    hide: () => Promise<void>;
+}
+export interface LocksFacade {
+    show: () => Promise<void>;
+    hide: () => Promise<void>;
+    addRangeLock: (options: Record<string, unknown>) => Promise<void>;
+    addSheetLock: (options: Record<string, unknown>) => Promise<void>;
+    removeRangeLocksInRanges: (options: Record<string, unknown>) => Promise<void>;
+    removeSheetLock: (options: Record<string, unknown>) => Promise<void>;
+}
+export interface MentionFacade {
+    locateCellByGuid: (guid: string, notificationType?: string) => Promise<void>;
+}
+export interface ContentFacade {
+    setContent: (content: unknown) => Promise<void>;
+}
+export interface VersionFacade {
+    createRevision: (options?: {
+        name?: string;
+    }) => Promise<void>;
+}
+export interface PresentationFacade {
+    start: (index?: number) => Promise<void>;
+    quit: () => Promise<void>;
+    startFromCurrent: () => Promise<void>;
+    startRemoteLive: () => Promise<void>;
+    startSpeakerView: () => Promise<void>;
 }
 export declare const MessageEvent: typeof InvokeMethod;
 export declare class OfficeSDK extends TinyEmitter {
@@ -66,10 +106,37 @@ export declare class OfficeSDK extends TinyEmitter {
      */
     spreadsheet?: Spreadsheet.Editor;
     /**
-     * 专业幻灯片编辑器实例
-     * @deprecated - 用 `sdk.getEditor<T>()` 替代
+     * 当前套件支持的标题能力。
      */
-    presentation?: Presentation.Editor;
+    title?: TitleFacade;
+    /**
+     * 当前套件支持的历史能力。
+     */
+    history?: HistoryFacade;
+    /**
+     * 当前套件支持的评论能力。
+     */
+    comments?: CommentsFacade;
+    /**
+     * 当前套件支持的锁定能力。
+     */
+    locks?: LocksFacade;
+    /**
+     * 当前套件支持的提及定位能力。
+     */
+    mention?: MentionFacade;
+    /**
+     * 当前套件支持的内容写入能力。
+     */
+    content?: ContentFacade;
+    /**
+     * 当前套件支持的版本能力。
+     */
+    version?: VersionFacade;
+    /**
+     * 当前套件支持的演示能力。
+     */
+    presentation?: PresentationFacade;
     /**
      * 应用表格编辑器实例
      * @deprecated - 用 `sdk.getEditor<T>()` 替代
@@ -114,6 +181,8 @@ export declare class OfficeSDK extends TinyEmitter {
     private readonly headerBarsCommands;
     private readonly headerBarsCommandOverrides;
     private readonly headerBarsCommandRefs;
+    private headerBarsTitleChangeHandler?;
+    private headerBarsTitleChangeSubscribed;
     private readonly onViewportResize;
     /**
      * 归一化后的缺省页配置，构造时一次算完，后续仅读取。
@@ -164,12 +233,42 @@ export declare class OfficeSDK extends TinyEmitter {
      */
     private bindContainerMethodHandlers;
     private initHeaderBarsFacade;
+    /**
+     * 订阅 iframe 侧 titleChange 事件，并在宿主设置了 headerBars.onTitleChange 时转发标题值。
+     * 输入：无。
+     * 输出：监听建立成功后返回 Promise<void>；重复调用只会订阅一次。
+     */
+    private ensureHeaderBarsTitleChangeSubscription;
     private invokeHeaderBars;
     private syncHeaderBarsCommands;
     private applyHeaderBarsChanged;
     private syncHeaderBarsVisible;
     private setHeaderBarsVisible;
     private getHeaderBarsCommandRef;
+    /**
+     * 按当前套件挂载根级能力命名空间。
+     * 输入：无，读取当前 fileType。
+     * 输出：直接更新 SDK 实例上的根级 facade 字段。
+     */
+    private installRootFacade;
+    /**
+     * 重置根级能力命名空间，避免不同套件间字段残留。
+     * 输入：无。
+     * 输出：将所有 facade 字段置空。
+     */
+    private clearRootFacade;
+    /**
+     * 调用显式 editor facade method-path。
+     * 输入：method-path 与参数数组。
+     * 输出：返回 iframe 侧序列化结果。
+     */
+    private invokeEditorFacade;
+    /**
+     * 为结构化 facade 建立 editor 事件监听，并返回取消监听函数。
+     * 输入：事件名与监听器。
+     * 输出：返回一个可取消当前监听的函数。
+     */
+    private listenEditorEvent;
     private initEditor;
     private shouldHandleMessage;
     private getContainerRect;

package/dist/editorFacade.contract.d.ts

@@ -0,0 +1,16 @@
+import type { OfficeSDK } from './OfficeSDK';
+type IsAssignable<T, U> = T extends U ? true : false;
+type Assert<T extends true> = T;
+export type EditorFacadeContractAssertions = [
+    Assert<IsAssignable<NonNullable<OfficeSDK['title']>['setTitle'], (title: string) => Promise<void>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['title']>['addChangedListener'], (listener: (title: string) => void) => () => void>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['locks']>['addRangeLock'], (options: Record<string, unknown>) => Promise<void>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['history']>['show'], () => Promise<void>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['mention']>['locateCellByGuid'], (guid: string, notificationType?: string) => Promise<void>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['version']>['createRevision'], (options?: {
+        name?: string;
+    }) => Promise<void>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['presentation']>['start'], (index?: number) => Promise<void>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['presentation']>['startFromCurrent'], () => Promise<void>>>
+];
+export {};