pptx-react-viewer 4.36.3 → 4.38.0

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, 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, 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';
@@ -13,7 +13,7 @@ import React$1, { Dispatch, SetStateAction, MutableRefObject, RefObject, Forward
  */
 type SupportedShapeType = 'rect' | 'roundRect' | 'ellipse' | 'triangle' | 'rtTriangle' | 'diamond' | 'cylinder' | 'parallelogram' | 'trapezoid' | 'pentagon' | 'hexagon' | 'octagon' | 'chevron' | 'star5' | 'star6' | 'star8' | 'plus' | 'heart' | 'cloud' | 'sun' | 'moon' | 'pie' | 'plaque' | 'teardrop' | 'line' | 'rtArrow' | 'leftArrow' | 'upArrow' | 'downArrow' | 'connector' | 'freeform';
 /** The pixel dimensions of the slide canvas (presentation slide size). */
-interface CanvasSize {
+interface CanvasSize$1 {
   /** Width of the canvas in CSS pixels. */
   width: number;
   /** Height of the canvas in CSS pixels. */
@@ -296,7 +296,7 @@ interface ToolbarProps {
   onArmFreeformTool?: (tool: FreeformToolKind | null) => void;
   onAddTextBox: () => void;
   onAddShape: () => void;
-  onAddTable: () => void;
+  onAddTable: (rows?: number, columns?: number) => void;
   onAddChart?: (chartKind: InsertChartKind) => void;
   onAddSmartArt: () => void;
   onAddEquation: () => void;
@@ -432,6 +432,8 @@ interface ToolbarProps {
   isCommentsPanelOpen?: boolean;
   spellCheckActive?: boolean;
   slideCommentCount?: number;
+  /** Review > Comments Previous / Next / Delete: the deck's slides and how to rewrite them. */
+  reviewComments?: ReviewCommentsHost;
   formatPainterActive?: boolean;
   onToggleFormatPainter?: () => void;
   canActivateFormatPainter?: boolean;
@@ -527,7 +529,7 @@ interface CanvasInteractionHandlers {
 //#region src/viewer/hooks/useEditorHistory.d.ts
 interface EditorHistoryInput {
   slides: PptxSlide[];
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   activeSlideIndex: number;
   templateElementsBySlideId: Record<string, PptxElement[]>;
   selectedElementId: string | null;
@@ -556,7 +558,7 @@ interface EditorHistoryInput {
    */
   onDirty?: () => void;
   setSlides: (slides: PptxSlide[]) => void;
-  setCanvasSize: (size: CanvasSize) => void;
+  setCanvasSize: (size: CanvasSize$1) => void;
   setActiveSlideIndex: (index: number) => void;
   setTemplateElementsBySlideId: (map: Record<string, PptxElement[]>) => void;
   setSelectedElementId: (id: string | null) => void;
@@ -665,7 +667,7 @@ declare function useElementOperations(input: UseElementOperationsInput): Element
 interface UseCanvasInteractionsInput {
   mode: ViewerMode;
   canEdit: boolean;
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   activeSlideIndex: number;
   selectedElementId: string | null;
   selectedElementIds: string[];
@@ -917,7 +919,7 @@ interface HyperlinkEditData {
 interface UseInsertElementsInput {
   activeSlide: PptxSlide | undefined;
   activeSlideIndex: number;
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   newShapeType: SupportedShapeType;
   selectedElements: PptxElement[];
   ops: ElementOperations;
@@ -928,7 +930,7 @@ interface InsertElementHandlers {
   addElement: (element: PptxElement) => void;
   handleAddTextBox: () => void;
   handleAddShape: () => void;
-  handleAddTable: () => void;
+  handleAddTable: (rows?: number, columns?: number) => void;
   handleAddChart: (chartKind: InsertChartKind) => void;
   handleInsertSmartArt: (layout: SmartArtLayout, defaultItems: string[]) => void;
   handleInsertEquation: (omml: Record<string, unknown>) => void;
@@ -1327,7 +1329,7 @@ interface UseViewerDialogsInput {
   /** Zero-based index of the active slide. */
   activeSlideIndex: number;
   /** Slide canvas dimensions (used for guide positioning). */
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   /** Ref to the container element (used for viewport width detection). */
   containerRef: React.RefObject<HTMLDivElement | null>;
   /** Custom shows defined in the presentation. */
@@ -1598,8 +1600,8 @@ interface ViewerCoreState extends InlineEditingState, EditPointsModeState {
   templateElementsBySlideId: Record<string, PptxElement[]>;
   setTemplateElementsBySlideId: React$1.Dispatch<React$1.SetStateAction<Record<string, PptxElement[]>>>;
   /** Width and height of the slide canvas in CSS pixels. */
-  canvasSize: CanvasSize;
-  setCanvasSize: React$1.Dispatch<React$1.SetStateAction<CanvasSize>>;
+  canvasSize: CanvasSize$1;
+  setCanvasSize: React$1.Dispatch<React$1.SetStateAction<CanvasSize$1>>;
   /**
    * `p:sldSz` in EMU, seeded from the loaded deck and updated by Design >
    * Slide Size. It is what a save persists: the pixel `canvasSize` above
@@ -1702,8 +1704,8 @@ interface ViewerCoreState extends InlineEditingState, EditPointsModeState {
   handoutMaster: PptxHandoutMaster | undefined;
   setHandoutMaster: React$1.Dispatch<React$1.SetStateAction<PptxHandoutMaster | undefined>>;
   /** Canvas dimensions for the notes page view (may differ from slide canvas). */
-  notesCanvasSize: CanvasSize | undefined;
-  setNotesCanvasSize: React$1.Dispatch<React$1.SetStateAction<CanvasSize | undefined>>;
+  notesCanvasSize: CanvasSize$1 | undefined;
+  setNotesCanvasSize: React$1.Dispatch<React$1.SetStateAction<CanvasSize$1 | undefined>>;
   /** User-defined custom document properties. */
   customProperties: PptxCustomProperty[];
   setCustomProperties: React$1.Dispatch<React$1.SetStateAction<PptxCustomProperty[]>>;
@@ -1919,7 +1921,7 @@ interface UseEditorOperationsInput {
   selectedElement: PptxElement | null;
   selectedElementId: string | null;
   selectedElementIds: string[];
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   dialogs: ViewerDialogsResult;
   presentation: UsePresentationModeResult;
   /** Display name for comment authoring. */
@@ -2014,7 +2016,7 @@ interface SlideCanvasProps {
   imagePaste?: CanvasImagePasteHandlers;
   activeSlide: PptxSlide | undefined;
   templateElements: PptxElement[];
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   zoom: ZoomViewport;
   mode: ViewerMode;
   canEdit: boolean;
@@ -2632,7 +2634,7 @@ interface SelectionBounds {
   maxY: number;
 }
 interface UseZoomViewportInput extends ViewportFitOptions {
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   selectedElements: PptxElement[];
 }
 interface UseZoomViewportResult {
@@ -2644,8 +2646,8 @@ interface UseZoomViewportResult {
   renderScaleRef: React.MutableRefObject<number>;
   scale: number;
   setScale: (scale: number) => void;
-  editorDimensions: CanvasSize | null;
-  setEditorDimensions: (dims: CanvasSize | null) => void;
+  editorDimensions: CanvasSize$1 | null;
+  setEditorDimensions: (dims: CanvasSize$1 | null) => void;
   fitScale: number;
   editorScale: number;
   handleZoomIn: () => void;
@@ -2787,7 +2789,7 @@ interface UseLoadContentInput {
   setSlides: React.Dispatch<React.SetStateAction<PptxSlide[]>>;
   setTemplateElementsBySlideId: React.Dispatch<React.SetStateAction<Record<string, PptxElement[]>>>;
   mediaDataUrls: Map<string, string>;
-  setCanvasSize: React.Dispatch<React.SetStateAction<CanvasSize>>;
+  setCanvasSize: React.Dispatch<React.SetStateAction<CanvasSize$1>>;
   /** Seeds the EMU `p:sldSz` that a save persists (see `ViewerCoreState.slideSizeEmu`). */
   setSlideSizeEmu: React.Dispatch<React.SetStateAction<SlideSizeEmu | undefined>>;
   setHeaderFooter: React.Dispatch<React.SetStateAction<PptxHeaderFooter>>;
@@ -2817,7 +2819,7 @@ interface UseLoadContentInput {
   setViewProperties: React.Dispatch<React.SetStateAction<PptxViewProperties | undefined>>;
   setNotesMaster: React.Dispatch<React.SetStateAction<PptxNotesMaster | undefined>>;
   setHandoutMaster: React.Dispatch<React.SetStateAction<PptxHandoutMaster | undefined>>;
-  setNotesCanvasSize: React.Dispatch<React.SetStateAction<CanvasSize | undefined>>;
+  setNotesCanvasSize: React.Dispatch<React.SetStateAction<CanvasSize$1 | undefined>>;
   setCustomProperties: React.Dispatch<React.SetStateAction<PptxCustomProperty[]>>;
   setTagCollections: React.Dispatch<React.SetStateAction<PptxTagCollection[]>>;
   setCoreProperties: React.Dispatch<React.SetStateAction<PptxCoreProperties | undefined>>;
@@ -2875,7 +2877,7 @@ declare function useLoadContent({ content, clearSelection, history, setSlides, s
 interface UsePointerHandlersInput {
   editorScale: number;
   canvasStageRef: React.RefObject<HTMLDivElement | null>;
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   activeSlide: PptxSlide | undefined;
   activeSlideIndex: number;
   gridSpacingPx: number;
@@ -2936,7 +2938,7 @@ interface UseSerializeInput {
   editTemplateMode?: boolean;
   masterViewTarget?: MasterViewTarget | null;
   /** The pixel canvas the raw Slide Size W/H inputs edit. */
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   /**
    * The EMU `p:sldSz` the viewer is holding (seeded on load, replaced by a
    * preset/orientation pick). Passed with `canvasSize` to
@@ -3065,7 +3067,7 @@ interface UseExportHandlersInput {
   /** Live theme, carried into the deck-JSON export document. */
   theme: PptxTheme | undefined;
   /** Slide canvas size in CSS pixels, carried into the deck-JSON export. */
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   /** The EMU `p:sldSz` the viewer holds, for the deck-JSON export's slide size. */
   slideSizeEmu?: SlideSizeEmu | undefined;
   /**
@@ -3180,7 +3182,7 @@ declare function useThemeHandlers(input: UseThemeHandlersInput): ThemeHandlersRe
 interface UsePropertyHandlersInput {
   slides: PptxSlide[];
   activeSlideIndex: number;
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   setContent: React.Dispatch<React.SetStateAction<ArrayBuffer | Uint8Array | null>>;
   setPresentationProperties: React.Dispatch<React.SetStateAction<PptxPresentationProperties>>;
   setCoreProperties: React.Dispatch<React.SetStateAction<PptxCoreProperties | null>>;
@@ -3408,7 +3410,7 @@ interface UseIOHandlersInput {
   state: ViewerState;
   slides: PptxSlide[];
   activeSlideIndex: number;
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   filePath: string | undefined;
   history: EditorHistoryResult;
   ops: ElementOperations;
@@ -3643,6 +3645,8 @@ interface ViewerIntegrationResult {
   recovery: UseRecoveryDetectionResult;
   isEncryptedDialogOpen: boolean;
   setIsEncryptedDialogOpen: Dispatch<SetStateAction<boolean>>;
+  /** Stable `PowerPointViewerAPI` view of the live handle (region `context.viewer`). */
+  viewerApi: PowerPointViewerAPI;
   /** The loaded core handler, exposed for the AI bridge (`getHandler`). */
   handlerRef: RefObject<PptxHandler | null>;
   /**
@@ -3969,7 +3973,7 @@ interface UseExportSaveAsInput {
   /** Live theme, carried into the deck-JSON export document. */
   theme: PptxTheme | undefined;
   /** Slide canvas size in CSS pixels, carried into the deck-JSON export. */
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   /** The EMU `p:sldSz` the viewer holds; see `UseExportHandlersInput`. */
   slideSizeEmu?: SlideSizeEmu | undefined;
 }
@@ -4424,7 +4428,7 @@ interface PresentationTransitionOverlayProps {
   /** Template/master elements that belong to the outgoing slide. */
   templateElements: PptxElement[];
   /** Canvas dimensions (slide width × height in EMU-derived px). */
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   /** Transition definition from the incoming slide. */
   transition: PptxSlideTransition;
   /** Resolved transition duration in ms. */
@@ -4465,7 +4469,7 @@ declare function PresentationTransitionOverlay({ outgoingSlide, templateElements
 //#endregion
 //#region src/viewer/components/MorphTransitionOverlay.d.ts
 interface MorphTransitionOverlayProps {
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   scale: number;
   morphPlan: MorphTransitionPlan;
   outgoingSlide: PptxSlide;
@@ -4489,7 +4493,7 @@ declare function MorphTransitionOverlay({ canvasSize, scale, morphPlan, outgoing
 interface SlideLayerProps {
   slide: PptxSlide;
   templateElements: PptxElement[];
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
 }
 declare function SlideLayer({ slide, templateElements, canvasSize }: SlideLayerProps): React$1.ReactElement;
 //#endregion
@@ -4498,7 +4502,7 @@ interface FragmentedTransitionLayerProps {
   layer: FragmentedLayer;
   slide: PptxSlide;
   templateElements: PptxElement[];
-  canvasSize: CanvasSize;
+  canvasSize: CanvasSize$1;
   scale: number;
   zIndex: number;
   layerName: 'outgoing' | 'incoming';