pptx-react-viewer 4.43.0 → 4.45.0

package/dist/index.d.ts

@@ -1,10 +1,12 @@
 import * as React$1 from 'react';
 import React$1__default from 'react';
 import * as ooxml_ui_pptx from 'ooxml-ui/pptx';
-import { CollaborationRole, CollaborationConfig, ViewportFitOptions, ViewerFontSource, CanvasSize, ViewerTheme, ThemeCatalogEntry, AccountAuthConfig, ToolbarActionId, RibbonAddInTab, ViewerCustomization, PowerPointViewerAPI, ViewerCustomizationApi, CollaborationLivePatcher, InlineListReadResult, EditorImagePasteOptions, ViewerMode, RulerUnit, ElementAnimationState, ShapeAdjustmentHandleDescriptor, InlineTextEditSnapshot, ZoomNavigationTarget, FieldSubstitutionContext, EditPointsCommandId, EditPointsElementPatch, FreeformToolKind, ElementClipboardPayload, AnimationApplyGroup, InsertChartKind, ChangeCaseMode, SlideTemplateId, ReviewCommentsHost, CollaborationShellState } from 'ooxml-ui/pptx';
+import { CollaborationRole, CollaborationConfig, ViewportFitOptions, ViewerFontSource, CanvasSize, ViewerTheme, ThemeCatalogEntry, AccountAuthConfig, CollaborationInput, ToolbarActionId, RibbonAddInTab, ViewerCustomization, PowerPointViewerAPI, ViewerCustomizationApi, CollaborationLivePatcher, InlineListReadResult, EditorImagePasteOptions, ViewerMode, RulerUnit, ElementAnimationState, ShapeAdjustmentHandleDescriptor, InlineTextEditSnapshot, ZoomNavigationTarget, FieldSubstitutionContext, EditPointsCommandId, EditPointsElementPatch, FreeformToolKind, ElementClipboardPayload, AnimationApplyGroup, InsertChartKind, ChangeCaseMode, SlideTemplateId, ReviewCommentsHost, CollaborationShellState } from 'ooxml-ui/pptx';
 export { AVATAR_COLOR_SWATCHES, AccountAuthConfig, BACKSTAGE_CARD_IDS, BACKSTAGE_PAGE_IDS, BackstageCustomization, CANVAS_CONTEXT_MENU_COMMAND_IDS, CollaborationConfig, CollaborationShellState, ContextMenuCustomization, DEFAULT_VIEWER_PROFILE, EDITOR_SHORTCUT_ACTION_IDS, ELEMENT_CONTEXT_MENU_COMMAND_IDS, ElementUpdate, ElementUpdateOptions, ExternalCollaborationAwareness, ExternalCollaborationSession, ExternalCollaborationSnapshot, HostCanvasMenuContext, HostElementMenuContext, HostMenuCommand, KeyboardCustomization, LocalStorageUsageSummary, OPTIONS_PAGE_IDS, OPTIONS_SECTION_IDS, OPTIONS_SETTING_IDS, OptionsCustomization, OptionsPageId, OptionsSectionId, OptionsSettingId, OptionsSettingValues, PPTX_OPEN_ACCEPT, PRESENTATION_OPEN_EXTENSIONS, PowerPointViewerAPI, RIBBON_TAB_IDS, ResolvedCustomization, RibbonCustomization, SLIDE_TEMPLATES, SavedPresentationFormat, ShortcutChord, SlideTemplateId, SlideTemplateSpec, StoredViewerPrefs, THEME_CATALOG, TOOLBAR_BUTTON_IDS, ThemeCatalogEntry, ToolbarActionId, ToolbarButtonId, ToolbarTabId, VIEWER_DIALOG_IDS, VIEWER_EXPORT_FORMAT_IDS, VIEWER_FEATURE_IDS, VIEWER_PANEL_IDS, VIEWER_PREFS_STORAGE_KEY, ViewerCustomization, ViewerCustomizationApi, ViewerDialogId, ViewerExportFormatId, ViewerFeatureId, ViewerMode, ViewerPanelId, ViewerProfile, ViewerTheme, ViewerThemeColors, ViewportFitOptions, ViewportFitPadding, buildSlideTemplateContent, buildSlideTemplateSlide, clearAllLocalViewerData, clearStoredViewerPrefs, createImageElementFromFile, defaultCssVars, defaultRadius, defaultThemeColors, describeCollaborationShellState, getLocalStorageUsageSummary, isLegacyBinaryPresentation, isSupportedPresentationFile, presentationBaseName, readStoredViewerPrefs, resolveProfileInitial, resolveThemeCatalogEntry, saveViewerProfile, savedPresentationFileName, themeToCssVars, vermilionDarkColors, vermilionDarkTheme, vermilionLightColors, vermilionLightTheme, vermilionRadius, writeStoredViewerPrefs } from 'ooxml-ui/pptx';
 import { LocaleCatalogEntry } from 'ooxml-ui/pptx/i18n';
 export { LOCALE_CATALOG, LocaleCatalogEntry } from 'ooxml-ui/pptx/i18n';
+import { CollaborationState } from 'ooxml-core/collab';
+export { CollaborationState } from 'ooxml-core/collab';
 import { PptxAiConfig } from 'ooxml-ui/pptx/ai';
 export { PptxAiBridge, PptxAiConfig, PptxAiConnection, PptxAiContextStrategy, PptxAiToolName, PptxAiWritePolicy } from 'ooxml-ui/pptx/ai';
 import { Doc } from 'yjs';
@@ -96,6 +98,8 @@ interface CollaborationContextValue {
   synced: boolean;
   /** Manually retry the WebSocket connection after a timeout or error. */
   retry: () => void;
+  /** The local awareness client id, once the session has one. */
+  clientId?: number | null;
 }
 //#endregion
 //#region src/viewer/hooks/useLoadNotifications.d.ts
@@ -302,7 +306,7 @@ interface PowerPointViewerProps extends ViewportFitOptions {
    * />
    * ```
    */
-  collaboration?: CollaborationConfig;
+  collaboration?: CollaborationInput;
   /**
    * Callback invoked when the user starts a collaboration session from the
    * Share dialog. The host app should use this to set the `collaboration`
@@ -314,6 +318,13 @@ interface PowerPointViewerProps extends ViewportFitOptions {
    * Share dialog. The host app should clear the `collaboration` prop.
    */
   onStopCollaboration?: () => void;
+  /**
+   * Reports the shared `CollaborationState` (the contract Word, Excel and Visio
+   * use): called when a session starts or stops (the off state), and when its
+   * connection status, synced flag or people change. Works for viewer-owned and
+   * host-owned (`collaboration.session`) sessions; unchanged states are not repeated.
+   */
+  onCollaborationChange?: (state: CollaborationState) => void;
   /**
    * Default values for the Share dialog fields. The host app should provide
    * these to control the session name, user display name, and server URL.
@@ -967,7 +978,7 @@ type AutosaveStatus = {
 //#region src/viewer/hooks/useViewerBuildingBlocks-types.d.ts
 interface UseViewerBuildingBlocksInput extends ViewportFitOptions {
   /** Optional collaboration, including a host-owned document and presence session. */
-  collaboration?: CollaborationConfig;
+  collaboration?: CollaborationInput;
   /** PPTX content as ArrayBuffer/Uint8Array, or null/undefined while no file is loaded. */
   content: ArrayBuffer | Uint8Array | null | undefined;
   /** Whether editing actions are enabled. Defaults to false (view-only). */
@@ -976,6 +987,13 @@ interface UseViewerBuildingBlocksInput extends ViewportFitOptions {
   filePath?: string;
   /** Display name for the toolbar's file-name-aware controls (e.g. title bar hosts build themselves). */
   fileName?: string;
+  /**
+   * Zero-based slide shown after each load, clamped into the deck, as `PowerPointViewer`'s
+   * `initialSlide`. It is applied in the same render that shows the loaded deck, so slide 1 is
+   * never shown first. Changing it later applies to the next load, not the current slide; use
+   * the handle's `goTo` to move an open deck.
+   */
+  initialSlide?: number;
   /** Whether the built-in autosave-to-localStorage recovery timer is active. Defaults to true. */
   autosaveEnabled?: boolean;
   /** Display name used as the author for comments. */

package/dist/index.js

@@ -1,8 +1,8 @@
 'use strict';
 
-var chunkCHPELGQD_js = require('./chunk-CHPELGQD.js');
-var chunkGLWV52C6_js = require('./chunk-GLWV52C6.js');
-var chunkFKY33ZKL_js = require('./chunk-FKY33ZKL.js');
+var chunkKUQRWMIK_js = require('./chunk-KUQRWMIK.js');
+var chunk2YCROYR6_js = require('./chunk-2YCROYR6.js');
+var chunkVJZJESNT_js = require('./chunk-VJZJESNT.js');
 require('./chunk-W2IMY5SY.js');
 var pptx = require('ooxml-ui/pptx');
 var i18n = require('ooxml-ui/pptx/i18n');
@@ -11,87 +11,87 @@ var i18n = require('ooxml-ui/pptx/i18n');
 
 Object.defineProperty(exports, "PowerPointViewer", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.PowerPointViewer; }
+  get: function () { return chunkKUQRWMIK_js.PowerPointViewer; }
 });
 Object.defineProperty(exports, "SlideCanvas", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.SlideCanvas; }
+  get: function () { return chunkKUQRWMIK_js.SlideCanvas; }
 });
 Object.defineProperty(exports, "SlideTemplateGalleryDialog", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.SlideTemplateGalleryDialog; }
+  get: function () { return chunkKUQRWMIK_js.SlideTemplateGalleryDialog; }
 });
 Object.defineProperty(exports, "SlideTemplatePreview", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.SlideTemplatePreview; }
+  get: function () { return chunkKUQRWMIK_js.SlideTemplatePreview; }
 });
 Object.defineProperty(exports, "THEME_CATALOG", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.THEME_CATALOG; }
+  get: function () { return chunkKUQRWMIK_js.THEME_CATALOG; }
 });
 Object.defineProperty(exports, "Toolbar", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.Toolbar; }
+  get: function () { return chunkKUQRWMIK_js.Toolbar; }
 });
 Object.defineProperty(exports, "ViewerThemeProvider", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.ViewerThemeProvider; }
+  get: function () { return chunkKUQRWMIK_js.ViewerThemeProvider; }
 });
 Object.defineProperty(exports, "defaultCssVars", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.defaultCssVars; }
+  get: function () { return chunkKUQRWMIK_js.defaultCssVars; }
 });
 Object.defineProperty(exports, "defaultRadius", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.defaultRadius; }
+  get: function () { return chunkKUQRWMIK_js.defaultRadius; }
 });
 Object.defineProperty(exports, "defaultThemeColors", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.defaultThemeColors; }
+  get: function () { return chunkKUQRWMIK_js.defaultThemeColors; }
 });
 Object.defineProperty(exports, "resolveThemeCatalogEntry", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.resolveThemeCatalogEntry; }
+  get: function () { return chunkKUQRWMIK_js.resolveThemeCatalogEntry; }
 });
 Object.defineProperty(exports, "themeToCssVars", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.themeToCssVars; }
+  get: function () { return chunkKUQRWMIK_js.themeToCssVars; }
 });
 Object.defineProperty(exports, "useViewerTheme", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.useViewerTheme; }
+  get: function () { return chunkKUQRWMIK_js.useViewerTheme; }
 });
 Object.defineProperty(exports, "vermilionDarkColors", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.vermilionDarkColors; }
+  get: function () { return chunkKUQRWMIK_js.vermilionDarkColors; }
 });
 Object.defineProperty(exports, "vermilionDarkTheme", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.vermilionDarkTheme; }
+  get: function () { return chunkKUQRWMIK_js.vermilionDarkTheme; }
 });
 Object.defineProperty(exports, "vermilionLightColors", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.vermilionLightColors; }
+  get: function () { return chunkKUQRWMIK_js.vermilionLightColors; }
 });
 Object.defineProperty(exports, "vermilionLightTheme", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.vermilionLightTheme; }
+  get: function () { return chunkKUQRWMIK_js.vermilionLightTheme; }
 });
 Object.defineProperty(exports, "vermilionRadius", {
   enumerable: true,
-  get: function () { return chunkCHPELGQD_js.vermilionRadius; }
+  get: function () { return chunkKUQRWMIK_js.vermilionRadius; }
 });
 Object.defineProperty(exports, "renderToCanvas", {
   enumerable: true,
-  get: function () { return chunkGLWV52C6_js.renderToCanvas; }
+  get: function () { return chunk2YCROYR6_js.renderToCanvas; }
 });
 Object.defineProperty(exports, "useViewerBuildingBlocks", {
   enumerable: true,
-  get: function () { return chunkGLWV52C6_js.useViewerBuildingBlocks; }
+  get: function () { return chunk2YCROYR6_js.useViewerBuildingBlocks; }
 });
 Object.defineProperty(exports, "getAnimationInitialStyle", {
   enumerable: true,
-  get: function () { return chunkFKY33ZKL_js.getAnimationInitialStyle; }
+  get: function () { return chunkVJZJESNT_js.getAnimationInitialStyle; }
 });
 Object.defineProperty(exports, "AVATAR_COLOR_SWATCHES", {
   enumerable: true,

package/dist/index.mjs

@@ -1,6 +1,6 @@
-export { PowerPointViewer, SlideCanvas, SlideTemplateGalleryDialog, SlideTemplatePreview, THEME_CATALOG, Toolbar, ViewerThemeProvider, defaultCssVars, defaultRadius, defaultThemeColors, resolveThemeCatalogEntry, themeToCssVars, useViewerTheme, vermilionDarkColors, vermilionDarkTheme, vermilionLightColors, vermilionLightTheme, vermilionRadius } from './chunk-ITV63NJ5.mjs';
-export { renderToCanvas, useViewerBuildingBlocks } from './chunk-UACDKMXF.mjs';
-export { getAnimationInitialStyle } from './chunk-3LIHPZKS.mjs';
+export { PowerPointViewer, SlideCanvas, SlideTemplateGalleryDialog, SlideTemplatePreview, THEME_CATALOG, Toolbar, ViewerThemeProvider, defaultCssVars, defaultRadius, defaultThemeColors, resolveThemeCatalogEntry, themeToCssVars, useViewerTheme, vermilionDarkColors, vermilionDarkTheme, vermilionLightColors, vermilionLightTheme, vermilionRadius } from './chunk-VUE3EPTJ.mjs';
+export { renderToCanvas, useViewerBuildingBlocks } from './chunk-66APV3YZ.mjs';
+export { getAnimationInitialStyle } from './chunk-FBN7UFW2.mjs';
 import './chunk-Q3DHYOLK.mjs';
 export { AVATAR_COLOR_SWATCHES, BACKSTAGE_CARD_IDS, BACKSTAGE_PAGE_IDS, CANVAS_CONTEXT_MENU_COMMAND_IDS, DEFAULT_VIEWER_PROFILE, EDITOR_SHORTCUT_ACTION_IDS, ELEMENT_CONTEXT_MENU_COMMAND_IDS, OPTIONS_PAGE_IDS, OPTIONS_SECTION_IDS, OPTIONS_SETTING_IDS, PPTX_OPEN_ACCEPT, PRESENTATION_OPEN_EXTENSIONS, RIBBON_TAB_IDS, SLIDE_TEMPLATES, TOOLBAR_BUTTON_IDS, VIEWER_DIALOG_IDS, VIEWER_EXPORT_FORMAT_IDS, VIEWER_FEATURE_IDS, VIEWER_PANEL_IDS, VIEWER_PREFS_STORAGE_KEY, buildSlideTemplateContent, buildSlideTemplateSlide, clearAllLocalViewerData, clearStoredViewerPrefs, createImageElementFromFile, describeCollaborationShellState, getLocalStorageUsageSummary, isLegacyBinaryPresentation, isSupportedPresentationFile, presentationBaseName, readStoredViewerPrefs, resolveProfileInitial, saveViewerProfile, savedPresentationFileName, writeStoredViewerPrefs } from 'ooxml-ui/pptx';
 export { LOCALE_CATALOG } from 'ooxml-ui/pptx/i18n';

package/dist/internals.d.ts

@@ -1,4 +1,4 @@
-import { CollaborationRole, CollaborationConfig, PowerPointViewerAPI, ViewerCustomizationApi, ShapeAdjustmentHandleDescriptor, ChangeCaseMode, ResolvedKeyboardCustomization, FindResult, EditorImagePasteOptions, InsertChartKind, PasteSpecialFormat, SlidePasteRequest, SlideTemplateId, MorphTransitionPlan, ElementAnimationState, ZoomNavigationTarget, PresentationSnapshot, ViewerMode, ShapeAdjustmentDragState, InlineTextEditSnapshot, InlineListReadResult, FreeformToolKind, CollaborationLivePatcher, SlideSizeEmu, ElementClipboardPayload, CropSession, FontEmbeddingDescriptor, MasterViewTarget, ViewportFitOptions, ToolbarActionId, CollaborationShellState, AnimationApplyGroup, ReviewCommentsHost, RulerUnit, FieldSubstitutionContext, EditPointsCommandId, EditPointsElementPatch, PresentationPointerTool, RunProgramNotice, BorrowedCollaborationAwareness, CollabLoadOrigin, AuthoredSlideRange, FragmentedLayer, PrintSettings, ThemeEditorEdit, CompareResult, ReadOnlyRecommendation, CompatibilityWarningToast, DeviceOrientation, ResolvedCustomization, DeckSavePurpose, ZoomExcursion, TouchGestureCallbacks, ViewerOptionsStore, ViewerOptions, AutosaveRecoveryPrompt, VirtualizedRange, ToolbarTabId } from 'ooxml-ui/pptx';
+import { CollaborationRole, CollaborationConfig, PowerPointViewerAPI, ViewerCustomizationApi, ShapeAdjustmentHandleDescriptor, ChangeCaseMode, ResolvedKeyboardCustomization, FindResult, EditorImagePasteOptions, InsertChartKind, PasteSpecialFormat, SlidePasteRequest, SlideTemplateId, MorphTransitionPlan, ElementAnimationState, ZoomNavigationTarget, PresentationSnapshot, ViewerMode, ShapeAdjustmentDragState, InlineTextEditSnapshot, InlineListReadResult, FreeformToolKind, CollaborationLivePatcher, SlideSizeEmu, ElementClipboardPayload, CropSession, FontEmbeddingDescriptor, MasterViewTarget, ViewportFitOptions, CollaborationInput, ToolbarActionId, CollaborationShellState, AnimationApplyGroup, ReviewCommentsHost, RulerUnit, FieldSubstitutionContext, EditPointsCommandId, EditPointsElementPatch, PresentationPointerTool, RunProgramNotice, BorrowedCollaborationAwareness, CollabLoadOrigin, AuthoredSlideRange, FragmentedLayer, PrintSettings, ThemeEditorEdit, CompareResult, ReadOnlyRecommendation, CompatibilityWarningToast, DeviceOrientation, ResolvedCustomization, DeckSavePurpose, ZoomExcursion, TouchGestureCallbacks, ViewerOptionsStore, ViewerOptions, AutosaveRecoveryPrompt, VirtualizedRange, ToolbarTabId } from 'ooxml-ui/pptx';
 export { CINEMATIC_TRANSITION_KEYFRAMES, CollaborationConfig, DEFAULT_MORPH_DURATION_MS, DEFAULT_TRANSITION_DURATION_MS, DeviceOrientation, EASE, INSTANT, MOBILE_BREAKPOINT, P14_TRANSITION_KEYFRAMES, P14_TRANSITION_KEYFRAMES_2, P14_TRANSITION_KEYFRAMES_ALL, RANDOM_ELIGIBLE_TYPES, ResolvedDirection, ResolvedDirection8, SLIDE_TRANSITION_KEYFRAMES, SLIDE_TRANSITION_KEYFRAMES_CSS, SlideTransitionAnimations, TABLET_BREAKPOINT, TRANSITION_SPEED_DURATION_MS, TouchGestureCallbacks, VirtualizedRange, WHEEL_SPOKE_COUNTS, computeVirtualRange, getCinematicTransitionAnimations, getP14TransitionAnimations, getSlideTransitionAnimations, resolveDirection, resolveDirection8, resolveOrientation, resolveSlideTransition, resolveTransitionDurationMs, resolveWheelSpokeCount } from 'ooxml-ui/pptx';
 import { PptxSlide, PptxElement, PptxElementAnimation, TextStyle, PptxHeaderFooter, ShapeStyle, PptxCommentMention, SmartArtLayout, InkPptxElement, ShapePptxElement, MergeShapeOperation, PptxSlideTransition, PptxAction, PptxSlideMaster, PptxModernCommentAuthor, PptxTheme, ParsedTableStyleMap, PptxThemeOption, PptxCustomShow, PptxSection, PptxPresentationProperties, PptxViewProperties, PptxNotesMaster, PptxHandoutMaster, PptxCustomProperty, PptxTagCollection, PptxCoreProperties, PptxAppProperties, PptxEmbeddedFont, MasterViewTab, PptxSlideLayout, PptxHandler, PptxLayoutOption, PptxLayoutPreview, PptxComment, ConnectorPptxElement, PptxThemePreset, PptxThemeColorScheme, PptxThemeFontScheme, PptxData, PptxHandlerSaveOptions, PptxSaveFormat, TextSegment, PptxModifyVerifier } from 'ooxml-core/pptx';
 import * as Y from 'yjs';
@@ -143,6 +143,8 @@ interface CollaborationContextValue {
   synced: boolean;
   /** Manually retry the WebSocket connection after a timeout or error. */
   retry: () => void;
+  /** The local awareness client id, once the session has one. */
+  clientId?: number | null;
 }
 //#endregion
 //#region src/viewer/types-ui.d.ts
@@ -2234,7 +2236,7 @@ declare function useAutosave(input: UseAutosaveInput): UseAutosaveResult;
 //#region src/viewer/hooks/useViewerBuildingBlocks-types.d.ts
 interface UseViewerBuildingBlocksInput extends ViewportFitOptions {
   /** Optional collaboration, including a host-owned document and presence session. */
-  collaboration?: CollaborationConfig;
+  collaboration?: CollaborationInput;
   /** PPTX content as ArrayBuffer/Uint8Array, or null/undefined while no file is loaded. */
   content: ArrayBuffer | Uint8Array | null | undefined;
   /** Whether editing actions are enabled. Defaults to false (view-only). */
@@ -2243,6 +2245,13 @@ interface UseViewerBuildingBlocksInput extends ViewportFitOptions {
   filePath?: string;
   /** Display name for the toolbar's file-name-aware controls (e.g. title bar hosts build themselves). */
   fileName?: string;
+  /**
+   * Zero-based slide shown after each load, clamped into the deck, as `PowerPointViewer`'s
+   * `initialSlide`. It is applied in the same render that shows the loaded deck, so slide 1 is
+   * never shown first. Changing it later applies to the next load, not the current slide; use
+   * the handle's `goTo` to move an open deck.
+   */
+  initialSlide?: number;
   /** Whether the built-in autosave-to-localStorage recovery timer is active. Defaults to true. */
   autosaveEnabled?: boolean;
   /** Display name used as the author for comments. */
@@ -2546,7 +2555,7 @@ interface UseCollaborativeStateInput {
   canvasWidth: number;
   canvasHeight: number;
 }
-declare function useCollaborativeState({ config, canvasWidth, canvasHeight }: UseCollaborativeStateInput): CollaborationContextValue | null;
+declare function useCollaborativeState({ config: requested, canvasWidth, canvasHeight }: UseCollaborativeStateInput): CollaborationContextValue | null;
 //#endregion
 //#region src/viewer/hooks/collaboration/useCollaborativeHistory.d.ts
 interface UseCollaborativeHistoryInput {