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

package/dist/OfficeSDK.d.ts

@@ -9,7 +9,7 @@ import { Document, DocumentPro, Presentation, Spreadsheet, Table, Form, Flowchar
 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 { CollaboratorFacade, CommentsFacade, ContentFacade, DiscussionFacade, DocsOutlineFacade, DocsSearchFacade, DocsSelectionFacade, DocsSettingsFacade, DocsSidebarFacade, DocsTablesFacade, ExternalAppFacade, HistoryFacade, LocksFacade, MentionFacade, OfficeSDKPresentationFacade, PresentationEventSubscriptionFacade, 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';
@@ -77,10 +77,10 @@ export declare class OfficeSDK extends TinyEmitter {
      */
     version?: VersionFacade;
     /**
-     * 幻灯片套件（Presentation）的演示能力，仅在幻灯片文件下挂载。
-     * 文档与表格套件不暴露演示 API，演示模式仅作为编辑器内 headerBars 能力保留。
+     * 当前套件支持的演示能力。
+     * 文档与表格支持 start / quit，幻灯片套件额外支持完整演示能力。
      */
-    presentation?: PresentationFacade;
+    presentation?: OfficeSDKPresentationFacade;
     /**
      * 当前套件支持的选区能力。
      */

package/dist/OfficeSDK.facade.types.d.ts

@@ -162,7 +162,9 @@ export interface ClipboardPasteParams {
 }
 export type SheetAppendDataAxis = 'row' | 'column';
 export interface SheetSelection {
-    getRange: (value?: SheetRangeValue) => SheetRangeFacade | null;
+    /** 当前 iframe runtime 内稳定的选区标识。 */
+    id: string;
+    getRange: (value?: SheetRangeValue) => Promise<SheetRangeFacade | null>;
     setRange: (value: SheetRangeValue | null) => Promise<void>;
 }
 export declare enum SheetRangeType {
@@ -429,24 +431,24 @@ export interface PresentationShapeBase {
     id: string;
     name: string;
     type: PresentationShapeType;
-    setFill: (fill: PresentationShapeFill) => void;
-    setLine: (line: PresentationShapeLine) => void;
-    setLayout: (layout: PresentationShapeLayout) => void;
-    remove: () => void;
+    setFill: (fill: PresentationShapeFill) => Promise<void>;
+    setLine: (line: PresentationShapeLine) => Promise<void>;
+    setLayout: (layout: PresentationShapeLayout) => Promise<void>;
+    remove: () => Promise<void>;
 }
 export type PresentationTextShapeType = Exclude<PresentationShapeType, PresentationLineShapeType>;
 export interface PresentationTextShape extends PresentationShapeBase {
     type: PresentationTextShapeType;
     textContent?: string;
-    setContent: (content: PresentationShapeContent) => void;
-    appendText: (text: string) => void;
-    appendParagraphs: (paragraphs: PresentationParagraph[]) => void;
+    setContent: (content: PresentationShapeContent) => Promise<void>;
+    appendText: (text: string) => Promise<void>;
+    appendParagraphs: (paragraphs: PresentationParagraph[]) => Promise<void>;
 }
 export type PresentationShape = PresentationShapeBase | PresentationTextShape;
 export type PresentationParagraphLineSpacing = 0.9 | 1.0 | 1.15 | 1.5 | 2.0 | 2.5 | 3.0;
 export interface PresentationTableCell {
-    setStyle: (style: PresentationTableCellStyle) => void;
-    clearStyle: () => void;
+    setStyle: (style: PresentationTableCellStyle) => Promise<void>;
+    clearStyle: () => Promise<void>;
 }
 export type PresentationTableCellStyle = PresentationTextStyle & PresentationParagraphStyle;
 export interface PresentationTableSelection {
@@ -456,25 +458,25 @@ export interface PresentationTableSelection {
     columnCount: number;
 }
 export interface PresentationTableRange {
-    setStyle: (style: PresentationTableCellStyle) => void;
-    clearStyle: () => void;
-    setSpan: () => void;
-    removeSpan: () => void;
+    setStyle: (style: PresentationTableCellStyle) => Promise<void>;
+    clearStyle: () => Promise<void>;
+    setSpan: () => Promise<void>;
+    removeSpan: () => Promise<void>;
 }
 export interface PresentationTableItem {
     id: string;
     rowCount: number;
     columnCount: number;
-    remove: () => void;
-    insertRows: (index: number, count: number, placement?: 'before' | 'after') => void;
-    insertColumns: (index: number, count: number, placement?: 'before' | 'after') => void;
-    deleteRows: (index: number, count: number) => void;
-    deleteColumns: (index: number, count: number) => void;
-    setRowHeight: (index: number, height: number) => void;
-    setColumnWidth: (index: number, width: number) => void;
-    getCell: (row: number, column: number) => PresentationTableCell | null;
-    getRange: (range: PresentationTableSelection) => PresentationTableRange | null;
-    setDirection: (direction: 'ltr' | 'rtl') => void;
+    remove: () => Promise<void>;
+    insertRows: (index: number, count: number, placement?: 'before' | 'after') => Promise<void>;
+    insertColumns: (index: number, count: number, placement?: 'before' | 'after') => Promise<void>;
+    deleteRows: (index: number, count: number) => Promise<void>;
+    deleteColumns: (index: number, count: number) => Promise<void>;
+    setRowHeight: (index: number, height: number) => Promise<void>;
+    setColumnWidth: (index: number, width: number) => Promise<void>;
+    getCell: (row: number, column: number) => Promise<PresentationTableCell | null>;
+    getRange: (range: PresentationTableSelection) => Promise<PresentationTableRange | null>;
+    setDirection: (direction: 'ltr' | 'rtl') => Promise<void>;
 }
 export interface PresentationTableOptions {
     offset: PresentationOffset;
@@ -512,14 +514,18 @@ export interface VersionFacade {
     hide?: () => Promise<void>;
     createRevision: (options?: RevisionCreateOptions) => Promise<undefined | null | DocumentErrorMessage>;
 }
-export interface PresentationFacade {
-    start: (index?: number) => Promise<void>;
+export interface BasicPresentationFacade {
+    start: () => Promise<void>;
     quit: () => Promise<void>;
+}
+export interface PresentationFacade extends BasicPresentationFacade {
+    start: (index?: number) => Promise<void>;
     startFromCurrent: () => Promise<void>;
     startRemoteLive: () => Promise<void>;
     startSpeakerView: () => Promise<void>;
     addChangeListener: (listener: (payload: unknown) => void) => () => void;
 }
+export type OfficeSDKPresentationFacade = BasicPresentationFacade | PresentationFacade;
 export interface DocsRangeFacade {
     start: number;
     end: number;
@@ -827,7 +833,7 @@ export interface OfficeSDKRootFacadeState {
     mention?: MentionFacade;
     content?: ContentFacade;
     version?: VersionFacade;
-    presentation?: PresentationFacade;
+    presentation?: OfficeSDKPresentationFacade;
     selection?: DocsSelectionFacade | PresentationSelectionFacade;
     search?: DocsSearchFacade;
     outline?: DocsOutlineFacade;

package/dist/editorFacade.contract.d.ts

@@ -1,5 +1,6 @@
-import type { AddChartFromSelectionResult, DocsRangeFacade, DocsRangeValue, DocsTableFacade, EditorTextFormat, OfficeSDK, PresentationSlideFacade, PresentationShape, PresentationShapeBase, PresentationTextShape, PresentationTextRangeFacade, PresentationTextRangeValue, SheetRangeValue, SheetRangeFacade, SheetSelection } from './OfficeSDK';
+import type { AddChartFromSelectionResult, BasicPresentationFacade, DocsRangeFacade, DocsRangeValue, DocsTableFacade, EditorTextFormat, OfficeSDK, PresentationFacade, PresentationSlideFacade, PresentationShape, PresentationShapeBase, PresentationTableCell, PresentationTableItem, PresentationTableRange, PresentationTableSelection, PresentationTextShape, PresentationTextRangeFacade, PresentationTextRangeValue, SheetRangeValue, SheetRangeFacade, SheetSelection } from './OfficeSDK';
 type IsAssignable<T, U> = T extends U ? true : false;
+type IsEqual<T, U> = (<V>() => V extends T ? 1 : 2) extends <V>() => V extends U ? 1 : 2 ? (<V>() => V extends U ? 1 : 2) extends <V>() => V extends T ? 1 : 2 ? true : false : false;
 type Assert<T extends true> = T;
 type RootSelection = NonNullable<OfficeSDK['selection']>;
 type DocsSelection = Extract<RootSelection, {
@@ -8,6 +9,7 @@ type DocsSelection = Extract<RootSelection, {
 type PresentationSelection = Extract<RootSelection, {
     getTextRange: (value?: PresentationTextRangeValue) => Promise<PresentationTextRangeFacade | null>;
 }>;
+type RootPresentation = NonNullable<OfficeSDK['presentation']>;
 export type EditorFacadeContractAssertions = [
     Assert<IsAssignable<NonNullable<OfficeSDK['title']>['setTitle'], (title: string) => Promise<void>>>,
     Assert<IsAssignable<NonNullable<OfficeSDK['title']>['addChangedListener'], (listener: (title: string) => void) => () => void>>,
@@ -15,12 +17,14 @@ export type EditorFacadeContractAssertions = [
     Assert<IsAssignable<NonNullable<OfficeSDK['history']>['show'], () => Promise<void>>>,
     Assert<IsAssignable<NonNullable<OfficeSDK['mention']>['locateCellByGuid'], (guid: string, notificationType?: import('./OfficeSDK').MentionTypes) => Promise<void>>>,
     Assert<IsAssignable<NonNullable<OfficeSDK['version']>['createRevision'], (options?: import('./OfficeSDK').RevisionCreateOptions) => Promise<undefined | null | import('./types/Document').DocumentErrorMessage>>>,
-    Assert<IsAssignable<NonNullable<OfficeSDK['presentation']>['start'], (index?: number) => Promise<void>>>,
-    Assert<IsAssignable<NonNullable<OfficeSDK['presentation']>['quit'], () => Promise<void>>>,
-    Assert<IsAssignable<NonNullable<OfficeSDK['presentation']>['startFromCurrent'], () => Promise<void>>>,
-    Assert<IsAssignable<NonNullable<OfficeSDK['presentation']>['startRemoteLive'], () => Promise<void>>>,
-    Assert<IsAssignable<NonNullable<OfficeSDK['presentation']>['startSpeakerView'], () => Promise<void>>>,
-    Assert<IsAssignable<NonNullable<OfficeSDK['presentation']>['addChangeListener'], (listener: (payload: unknown) => void) => () => void>>,
+    Assert<IsAssignable<RootPresentation, BasicPresentationFacade>>,
+    Assert<IsAssignable<RootPresentation['start'], () => Promise<void>>>,
+    Assert<IsAssignable<RootPresentation['quit'], () => Promise<void>>>,
+    Assert<IsAssignable<PresentationFacade['start'], (index?: number) => Promise<void>>>,
+    Assert<IsAssignable<PresentationFacade['startFromCurrent'], () => Promise<void>>>,
+    Assert<IsAssignable<PresentationFacade['startRemoteLive'], () => Promise<void>>>,
+    Assert<IsAssignable<PresentationFacade['startSpeakerView'], () => Promise<void>>>,
+    Assert<IsAssignable<PresentationFacade['addChangeListener'], (listener: (payload: unknown) => void) => () => void>>,
     Assert<IsAssignable<NonNullable<OfficeSDK['batchChanges']>, <T>(callback: () => T | Promise<T>) => Promise<Awaited<T>>>>,
     Assert<IsAssignable<NonNullable<OfficeSDK['print']>, () => Promise<void>>>,
     Assert<IsAssignable<NonNullable<OfficeSDK['export']>, (type: string) => Promise<void>>>,
@@ -45,6 +49,15 @@ 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<IsEqual<SheetSelection['getRange'], (value?: SheetRangeValue) => Promise<SheetRangeFacade | null>>>,
+    Assert<IsEqual<SheetSelection['id'], string>>,
+    Assert<IsEqual<PresentationShapeBase['setFill'], (fill: import('./OfficeSDK').PresentationShapeFill) => Promise<void>>>,
+    Assert<IsEqual<PresentationShapeBase['remove'], () => Promise<void>>>,
+    Assert<IsEqual<PresentationTableItem['getCell'], (row: number, column: number) => Promise<PresentationTableCell | null>>>,
+    Assert<IsEqual<PresentationTableItem['getRange'], (range: PresentationTableSelection) => Promise<PresentationTableRange | null>>>,
+    Assert<IsEqual<PresentationTableItem['insertRows'], (index: number, count: number, placement?: 'before' | 'after') => Promise<void>>>,
+    Assert<IsEqual<PresentationTableCell['clearStyle'], () => Promise<void>>>,
+    Assert<IsEqual<PresentationTableRange['setSpan'], () => Promise<void>>>
 ];
 export {};