weboffice-js-sdk 2.0.4 → 2.0.5-beta.1

package/dist/OfficeSDK.branding.d.ts

@@ -0,0 +1,28 @@
+export declare const BRANDING_METHOD: {
+    readonly getEditorFooterLogo: "branding.getEditorFooterLogo";
+    readonly setEditorFooterLogoSrc: "branding.setEditorFooterLogoSrc";
+};
+export declare const BRANDING_CHANGED_EVENT = "branding:changed";
+export type SDKBrandMode = '0' | '1' | '2';
+export type SDKBrandSource = 0 | 1 | 2 | 3;
+export interface SDKBrandConfig {
+    mode: SDKBrandMode;
+    customAddress?: string;
+    source: SDKBrandSource;
+}
+export interface BrandingChangedPayload {
+    editorFooterLogo?: SDKBrandConfig;
+}
+export interface BrandingFacade {
+    getEditorFooterLogo: () => Promise<SDKBrandConfig | undefined>;
+    setEditorFooterLogoSrc: (src: string) => Promise<void>;
+}
+interface BrandingHost {
+    getEditorFooterLogoState(): SDKBrandConfig | undefined;
+    setEditorFooterLogoState(config: SDKBrandConfig | undefined): void;
+    invokeBranding<T>(method: string, payload?: Record<string, unknown>): Promise<T>;
+    emitBrandingError(message: string, err: unknown): void;
+}
+export declare function initBrandingFacade(host: BrandingHost): BrandingFacade;
+export declare function applyBrandingChanged(host: BrandingHost, payload?: BrandingChangedPayload): void;
+export {};

package/dist/OfficeSDK.d.ts

@@ -11,8 +11,10 @@ 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';
+import type { BrandingFacade } from './OfficeSDK.branding';
 export * from './OfficeSDK.facade.types';
 export * from './OfficeSDK.headerBars';
+export * from './OfficeSDK.branding';
 export declare const MessageEvent: typeof InvokeMethod;
 export declare class OfficeSDK extends TinyEmitter {
     /**
@@ -168,6 +170,7 @@ export declare class OfficeSDK extends TinyEmitter {
      */
     flowchart?: Flowchart.Editor;
     readonly headerBars: HeaderBarsFacade;
+    readonly branding: BrandingFacade;
     private _fileType;
     private readonly messageHandler;
     /**
@@ -200,6 +203,7 @@ export declare class OfficeSDK extends TinyEmitter {
     private readonly headerBarsCommandRefs;
     private headerBarsTitleChangeHandler?;
     private headerBarsTitleChangeSubscribed;
+    private editorFooterLogo?;
     private readonly onViewportResize;
     /**
      * 归一化后的缺省页配置，构造时一次算完，后续仅读取。
@@ -284,6 +288,7 @@ export declare class OfficeSDK extends TinyEmitter {
      */
     private bindContainerMethodHandlers;
     private initHeaderBarsFacade;
+    private initBrandingFacade;
     /**
      * 订阅 iframe 侧 titleChange 事件，并在宿主设置了 headerBars.onTitleChange 时转发标题值。
      * 输入：无。
@@ -291,9 +296,12 @@ export declare class OfficeSDK extends TinyEmitter {
      */
     private ensureHeaderBarsTitleChangeSubscription;
     private invokeHeaderBars;
+    private invokeBranding;
     private syncHeaderBarsCommands;
     private createHeaderBarsHost;
+    private createBrandingHost;
     private applyHeaderBarsChanged;
+    private applyBrandingChanged;
     private syncHeaderBarsVisible;
     private setHeaderBarsVisible;
     private getHeaderBarsCommandRef;

package/dist/editorFacade.contract.d.ts

@@ -42,6 +42,8 @@ export type EditorFacadeContractAssertions = [
     Assert<IsAssignable<NonNullable<OfficeSDK['charts']>['addChartFromSelection'], (params?: import('./OfficeSDK').AddChartFromSelectionParams) => Promise<AddChartFromSelectionResult | undefined>>>,
     Assert<IsAssignable<PresentationSelection['getSelectedShapes'], (ids?: string[]) => Promise<PresentationShape[] | null>>>,
     Assert<IsAssignable<NonNullable<OfficeSDK['zoom']>['setPercentage'], (percentage: number) => Promise<void>>>,
-    Assert<IsAssignable<NonNullable<OfficeSDK['eventSubscription']>['addLoadedListener'], (listener: () => void) => () => void>>
+    Assert<IsAssignable<NonNullable<OfficeSDK['eventSubscription']>['addLoadedListener'], (listener: () => void) => () => void>>,
+    Assert<IsAssignable<OfficeSDK['branding']['getEditorFooterLogo'], () => Promise<import('./OfficeSDK').SDKBrandConfig | undefined>>>,
+    Assert<IsAssignable<OfficeSDK['branding']['setEditorFooterLogoSrc'], (src: string) => Promise<void>>>
 ];
 export {};