weboffice-js-sdk 2.0.3 → 2.0.4

package/dist/OfficeSDK.headerBars.d.ts

@@ -0,0 +1,87 @@
+export declare const HEADER_BARS_METHOD: {
+    readonly getVisible: "headerBars.getVisible";
+    readonly setVisible: "headerBars.setVisible";
+    readonly addCommand: "headerBars.addCommand";
+    readonly getCommand: "headerBars.getCommand";
+    readonly setCommandVisible: "headerBars.setCommandVisible";
+    readonly setCommandDisabled: "headerBars.setCommandDisabled";
+    readonly setCommandActive: "headerBars.setCommandActive";
+    readonly setCommandSrc: "headerBars.setCommandSrc";
+    readonly setCommandLabel: "headerBars.setCommandLabel";
+    readonly setCommandEditable: "headerBars.setCommandEditable";
+    readonly setCommandCallbackEnabled: "headerBars.setCommandCallbackEnabled";
+    readonly listViewCommands: "headerBars.listViewCommands";
+    readonly handleCommandClick: "headerBars.handleCommandClick";
+};
+export declare const HEADER_BARS_CHANGED_EVENT = "headerBars:changed";
+export interface HeaderBarsCommandDefinition {
+    id: string;
+    section?: string;
+    order?: number;
+    label?: string;
+    visible?: boolean;
+    disabled?: boolean;
+    active?: boolean;
+    editable?: boolean;
+    type?: 'action' | 'structural';
+    renderType?: string;
+    src?: string;
+    onClick?: () => void | Promise<void>;
+}
+export interface HeaderBarsCommandState extends HeaderBarsCommandDefinition {
+    type: 'action' | 'structural';
+}
+export interface HeaderBarsCommandRef {
+    readonly id: string;
+    visible: boolean;
+    disabled: boolean;
+    active: 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[]>;
+}
+export interface HeaderBarsChangedPayload {
+    reason?: string;
+    commandId?: string;
+    version?: number;
+    snapshot?: {
+        visible: boolean;
+        commands: HeaderBarsCommandState[];
+    };
+}
+interface HeaderBarsHost {
+    getVisibleState(): boolean;
+    setVisibleState(visible: boolean): void;
+    getCommandsMap(): Map<string, HeaderBarsCommandState>;
+    getOverridesMap(): Map<string, (() => void | Promise<void>) | undefined>;
+    getRefsMap(): Map<string, HeaderBarsCommandRef>;
+    getTitleHandler(): HeaderBarsTitleChangeHandler | undefined;
+    setTitleHandler(handler: HeaderBarsTitleChangeHandler | undefined): void;
+    isTitleSubscribed(): boolean;
+    setTitleSubscribed(subscribed: boolean): void;
+    invokeHeaderBars<T>(method: string, payload?: Record<string, unknown>): Promise<T>;
+    emitHeaderBarsError(message: string, err: unknown): void;
+    onInternalTitleChange(listener: (title: unknown) => void): void;
+    subscribeEditorTitleChange(): Promise<void>;
+}
+export declare function initHeaderBarsFacade(host: HeaderBarsHost): HeaderBarsFacade;
+export declare function ensureHeaderBarsTitleChangeSubscription(host: HeaderBarsHost): Promise<void>;
+export declare function syncHeaderBarsCommands(host: HeaderBarsHost, commands: HeaderBarsCommandState[]): void;
+export declare function applyHeaderBarsChanged(host: HeaderBarsHost, payload?: HeaderBarsChangedPayload): void;
+export declare function syncHeaderBarsVisible(host: HeaderBarsHost): Promise<boolean>;
+export declare function setHeaderBarsVisible(host: HeaderBarsHost, visible: boolean): Promise<void>;
+export declare function getHeaderBarsCommandRef(host: HeaderBarsHost, id: string): HeaderBarsCommandRef;
+export declare function subscribeHeaderBarsTitleChange(invoke: <T>(method: string, args: unknown[]) => Promise<T>): Promise<void>;
+export {};

package/dist/editorFacade.contract.d.ts

@@ -0,0 +1,47 @@
+import type { AddChartFromSelectionResult, DocsRangeFacade, DocsRangeValue, DocsTableFacade, EditorTextFormat, OfficeSDK, PresentationSlideFacade, PresentationShape, PresentationShapeBase, PresentationTextShape, PresentationTextRangeFacade, PresentationTextRangeValue, SheetRangeValue, SheetRangeFacade, SheetSelection } from './OfficeSDK';
+type IsAssignable<T, U> = T extends U ? true : false;
+type Assert<T extends true> = T;
+type RootSelection = NonNullable<OfficeSDK['selection']>;
+type DocsSelection = Extract<RootSelection, {
+    getRange: (value?: DocsRangeValue) => Promise<DocsRangeFacade | null>;
+}>;
+type PresentationSelection = Extract<RootSelection, {
+    getTextRange: (value?: PresentationTextRangeValue) => Promise<PresentationTextRangeFacade | null>;
+}>;
+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: import('./OfficeSDK').AddRangeLockParams) => Promise<void>>>,
+    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']>['startFromCurrent'], () => Promise<void>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['presentation']>['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>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['setFocus']>, (isFocus: boolean) => Promise<void>>>,
+    Assert<IsAssignable<DocsSelection['getRange'], (value?: DocsRangeValue) => Promise<DocsRangeFacade | null>>>,
+    Assert<IsAssignable<PresentationSelection['getTextRange'], (value?: PresentationTextRangeValue) => Promise<PresentationTextRangeFacade | null>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['tables']>['getAll'], () => Promise<DocsTableFacade[]>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['workbook']>['getWorksheets'], () => Promise<import('./OfficeSDK').SheetWorksheetFacade[]>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['activeSheet']>['getCell'], (row: number, column: number) => Promise<import('./OfficeSDK').SheetCellFacade | null>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['slides']>['getCurrentSlide'], () => Promise<PresentationSlideFacade>>>,
+    Assert<IsAssignable<PresentationSlideFacade['insertTextBox'], (options: import('./OfficeSDK').PresentationTextBoxOptions) => Promise<PresentationTextShape>>>,
+    Assert<IsAssignable<PresentationSlideFacade['insertShape'], (options: Extract<import('./OfficeSDK').PresentationInsertShapeOptions, {
+        type: import('./OfficeSDK').PresentationLineShapeType;
+    }>) => Promise<PresentationShapeBase>>>,
+    Assert<IsAssignable<PresentationSlideFacade['insertShape'], (options: Extract<import('./OfficeSDK').PresentationInsertShapeOptions, {
+        type: import('./OfficeSDK').PresentationTextShapeType;
+    }>) => Promise<PresentationTextShape>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['text']>['apply'], (format: Partial<EditorTextFormat>, range?: PresentationTextRangeValue) => Promise<Partial<EditorTextFormat>>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['activeSheet']>['getSelections'], () => Promise<SheetSelection[] | null>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['activeSheet']>['getRange'], (value: SheetRangeValue) => Promise<SheetRangeFacade | null>>>,
+    Assert<IsAssignable<NonNullable<OfficeSDK['selections']>['getAll'], () => Promise<SheetRangeValue[]>>>,
+    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>>
+];
+export {};

package/{index.d.ts → dist/index.d.ts}

@@ -9,5 +9,8 @@ import { EventMap as BaseEventMap, BaseEditor } from './types/BaseEditor';
 export * from 'weboffice-js-sdk-shared';
 export * from './connect';
 export * from './OfficeSDK';
+export type { EmptyPageScene, EmptyPageOptions, EmptyPageActionOverride, EmptyPageContentOverride, NormalizedEmptyPageOptions, EmptyPageShownPayload, EmptyPageActionPayload, EmptyPageHiddenPayload, FileOpenFailedReason, TokenExpiredStrategy } from './types/EmptyPage';
+export type { SlashMenuButton, SlashMenuEntry, SlashMenuOptions } from './types/SlashMenu';
+export { ALL_EMPTY_PAGE_SCENES, normalizeEmptyPageOptions } from './types/EmptyPage';
 export { BaseEditor, DocumentPro, Document, Spreadsheet, Presentation, Table, Form, Flowchart, BaseEventMap };
 export declare const START_PARAMS_FIELD = "smParams";