pptx-react-viewer 4.5.0 → 4.6.0

package/dist/internals.d.ts

@@ -13354,6 +13354,27 @@ interface PresentationInkStroke {
   width: number;
   points: PresentationInkPoint[];
 }
+/** A logical editor command produced by one key press. */
+type EditorKeyActionName = 'undo' | 'redo' | 'copy' | 'cut' | 'paste' | 'duplicate' | 'delete' | 'selectAll' | 'group' | 'ungroup' | 'nudge' | 'prevSlide' | 'nextSlide' | 'escape' | 'find' | 'findReplace' | 'toggleShortcuts' | 'alignLeft' | 'alignCenter' | 'alignRight' | 'alignJustify' | 'increaseFontSize' | 'decreaseFontSize' | 'copyFormat' | 'pasteFormat' | 'newSlide' | 'hyperlink' | 'clearFormatting' | 'cycleSelectionNext' | 'cycleSelectionPrev' | 'pasteSpecial';
+/** Every command a canvas context menu can offer, in no particular order. */
+type ContextMenuCommandId = 'copy' | 'cut' | 'paste' | 'duplicate' | 'edit-text' | 'bring-forward' | 'send-backward' | 'bring-front' | 'send-back' | 'ai-ask' | 'ai-fix' | 'comment' | 'hyperlink' | 'table-insert-row-above' | 'table-insert-row-below' | 'table-delete-row' | 'table-insert-col-left' | 'table-insert-col-right' | 'table-delete-col' | 'table-merge-selected' | 'table-merge-right' | 'table-merge-down' | 'table-split' | 'group' | 'ungroup' | 'save-as-picture' | 'edit-alt-text' | 'size-and-position' | 'format-shape' | 'delete';
+//#endregion
+//#region src/render/canvas-context-menu-commands.d.ts
+/**
+ * The right-click menu for the empty slide canvas (no element under the
+ * cursor), as distinct from {@link ./context-menu-commands}'s per-element menu.
+ *
+ * Right-clicking empty canvas used to do nothing at all in every binding: React
+ * and Vue both bailed out early (`getElementIdFromEvent` returns `null`, so the
+ * handler just returns) rather than opening a menu, and the other three never
+ * wired a handler for it either. PowerPoint offers Paste, Layout, Reset,
+ * Format Background and view toggles (Grid and Guides, Ruler) from this menu;
+ * this module is the one list every binding renders instead of five omissions.
+ *
+ * @module render/canvas-context-menu-commands
+ */
+/** Every command the empty-canvas context menu can offer, in no particular order. */
+type CanvasContextMenuCommandId = 'paste' | 'layout' | 'reset-slide' | 'format-background' | 'grid-and-guides' | 'ruler';
 //#endregion
 //#region src/render/paste-special.d.ts
 /** The four paste formats PowerPoint's Paste Options / Paste Special offer. */
@@ -13487,6 +13508,21 @@ interface AutosaveRecoveryPrompt {
   readonly restoreKey: string;
   readonly discardKey: string;
 }
+type BackstagePage = 'home' | 'new' | 'open' | 'info' | 'save' | 'saveAs' | 'print' | 'share' | 'export' | 'close' | 'account' | 'options';
+//#endregion
+//#region src/render/backstage-cards.d.ts
+/**
+ * Every action card the File-tab backstage can show, keyed by the operation it
+ * triggers rather than by its wording.
+ *
+ * The five bindings used to hardcode a title and a body string each, which made
+ * the whole backstage untranslatable and let the copy drift: the same card
+ * carried four different descriptions depending on which binding you opened it
+ * in. Both halves now live here as a dictionary key plus an English fallback,
+ * so a wording change lands everywhere at once and a translator only has to
+ * translate it once.
+ */
+type BackstageCardId = 'protect' | 'inspect' | 'embedFonts' | 'signatures' | 'versionHistory' | 'saveAsPptx' | 'saveAsPpsx' | 'saveAsPptm' | 'saveAsPpt' | 'pdf' | 'png' | 'video' | 'gif' | 'json' | 'copyImage' | 'print' | 'share';
 //#endregion
 //#region src/render/master-view.d.ts
 /** Which part the master view is currently pointed at. */
@@ -13792,6 +13828,136 @@ interface PrintSettings {
   scaleToFit?: boolean;
 }
 //#endregion
+//#region src/render/options/viewer-options-controls.d.ts
+/**
+ * Control/section/tab descriptor types for the File > Options schema, plus
+ * the terse constructors the tab-definition modules build panes with.
+ */
+type ViewerOptionsTabId = 'general' | 'proofing' | 'save' | 'language' | 'accessibility' | 'advanced' | 'ribbon' | 'quickAccess' | 'addIns' | 'trust';
+//#endregion
+//#region src/render/customization/customization-types.d.ts
+/** Keys of an options group whose value is a primitive (not an array). */
+type PrimitiveKeys<T> = { [K in keyof T]: T[K] extends ViewerOptionPrimitive ? K : never; }[keyof T] & string;
+/**
+ * One File > Options setting, addressed as `<group>.<key>`, for example
+ * `general.userName` or `advanced.showGrid`. The union is derived from the
+ * `ViewerOptions` model itself, so a typo is a compile error.
+ */
+type OptionsSettingId = { [G in ViewerOptionsGroupId]: `${G}.${PrimitiveKeys<ViewerOptions[G]>}`; }[ViewerOptionsGroupId];
+/**
+ * A File > Options page: the ten PowerPoint categories plus `ai`, the AI
+ * assistant page a binding adds when the host configured an assistant.
+ */
+type OptionsPageId = ViewerOptionsTabId | 'ai';
+/**
+ * One section of an Options page, addressed as `<page>.<section>`, for
+ * example `general.personalize` or `advanced.print`. The full list is
+ * `OPTIONS_SECTION_IDS` (derived from the schema at runtime).
+ */
+type OptionsSectionId = `${ViewerOptionsTabId}.${string}`;
+/** Values a host forces onto settings. */
+type OptionsSettingValues = Partial<Record<OptionsSettingId, ViewerOptionPrimitive>>;
+/** Ribbon and toolbar customisation. */
+interface RibbonCustomization {
+  /** Ribbon tabs to remove (the File tab included, unlike Customize Ribbon). */
+  hiddenTabs?: readonly ToolbarTabId[];
+  /** Top-level toolbar buttons / control clusters to remove. */
+  hiddenButtons?: readonly ToolbarButtonId[];
+}
+/** File > Options (the Settings dialog) customisation. */
+interface OptionsCustomization {
+  /** Whole pages to remove from the dialog's category rail. */
+  hiddenPages?: readonly OptionsPageId[];
+  /** Sections (`<page>.<section>`) to remove from their page. */
+  hiddenSections?: readonly OptionsSectionId[];
+  /** Individual settings (`<group>.<key>`) to remove wherever they appear. */
+  hiddenSettings?: readonly OptionsSettingId[];
+  /**
+   * Settings pinned to a fixed value. The value is forced into the options
+   * store, user edits to it are ignored, and the control renders read-only.
+   * Add the id to `hiddenSettings` too to lock it invisibly.
+   */
+  locked?: OptionsSettingValues;
+  /**
+   * Host defaults: the value a setting starts at when the user has not saved
+   * a choice of their own. "Reset" returns to these, not to the built-ins.
+   */
+  defaults?: OptionsSettingValues;
+}
+/** File tab (backstage) customisation. */
+interface BackstageCustomization {
+  /** Navigation entries (pages) to remove from the File tab. */
+  hiddenPages?: readonly BackstagePage[];
+  /** Action cards to remove from the pages that show them. */
+  hiddenCards?: readonly BackstageCardId[];
+}
+/** Right-click menu customisation. */
+interface ContextMenuCustomization {
+  /** Entries to remove from the element (right-click on a shape) menu. */
+  hiddenElementCommands?: readonly ContextMenuCommandId[];
+  /** Entries to remove from the empty-canvas menu. */
+  hiddenCanvasCommands?: readonly CanvasContextMenuCommandId[];
+  /** Remove the element context menu entirely. */
+  disableElementMenu?: boolean;
+  /** Remove the empty-canvas context menu entirely. */
+  disableCanvasMenu?: boolean;
+}
+/**
+ * A shortcut chord in the form `Mod+Shift+D`: modifiers `Mod` (Ctrl on
+ * Windows/Linux, Cmd on macOS), `Ctrl`, `Meta`, `Alt`, `Shift`, joined by `+`,
+ * followed by a `KeyboardEvent.key` value (`D`, `Delete`, `ArrowLeft`, `F2`).
+ */
+type ShortcutChord = string;
+/** Editor keyboard-shortcut customisation. */
+interface KeyboardCustomization {
+  /** Turn every editor shortcut off (the host owns the keyboard). */
+  disableAll?: boolean;
+  /** Editor commands whose shortcut is turned off. */
+  disabled?: readonly EditorKeyActionName[];
+  /**
+   * Replacement chords per command. A remapped command no longer answers to
+   * its built-in chord; it answers to the chord(s) given here instead.
+   */
+  remap?: Partial<Record<EditorKeyActionName, ShortcutChord | readonly ShortcutChord[]>>;
+}
+/**
+ * Chrome regions a host can remove. Each id maps onto one region in every
+ * binding; see `VIEWER_PANEL_IDS` for the catalogue.
+ */
+type ViewerPanelId = 'statusBar' | 'slidesPane' | 'inspector' | 'notes' | 'quickAccessToolbar' | 'titleBar';
+/** Feature areas that can be switched off as a whole. */
+type ViewerFeatureId = 'ai' | 'collaboration' | 'comments' | 'presentMode';
+/** Dialogs (and the entry points that open them) a host can remove. */
+type ViewerDialogId = 'options' | 'share' | 'broadcast' | 'print' | 'export';
+/** Export formats offered by the File > Export page. */
+type ViewerExportFormatId = 'pdf' | 'png' | 'video' | 'gif' | 'json' | 'copyImage';
+/**
+ * The whole customisation object. Every field is optional; omitted fields hide
+ * nothing and lock nothing.
+ */
+interface ViewerCustomization {
+  ribbon?: RibbonCustomization;
+  options?: OptionsCustomization;
+  backstage?: BackstageCustomization;
+  contextMenu?: ContextMenuCustomization;
+  keyboard?: KeyboardCustomization;
+  /** Chrome regions to remove (`true` hides). */
+  hiddenPanels?: readonly ViewerPanelId[];
+  /** Feature areas to switch off (their buttons, menus, pages and panels). */
+  disabledFeatures?: readonly ViewerFeatureId[];
+  /** Dialogs to remove, along with every entry point that opens them. */
+  hiddenDialogs?: readonly ViewerDialogId[];
+  /** Export formats to remove from File > Export. */
+  hiddenExportFormats?: readonly ViewerExportFormatId[];
+}
+//#endregion
+//#region src/render/options/viewer-options-constraints.d.ts
+/** Locks and host defaults, both keyed `<group>.<key>`. */
+interface ViewerOptionsConstraints {
+  locked?: OptionsSettingValues;
+  defaults?: OptionsSettingValues;
+}
+//#endregion
 //#region src/render/options/viewer-options-store.d.ts
 /**
  * Framework-neutral store behind the File > Options dialog.
@@ -13835,6 +14001,96 @@ interface ViewerOptionsStore {
    * operation costs a single render instead of one per field.
    */
   batch(write: () => void): void;
+  /**
+   * Apply host constraints (see `ViewerOptionsConstraints`): `locked` values
+   * are forced in and every later write to them is ignored; `defaults`
+   * replace the built-in defaults for settings the user never saved, and
+   * become what `reset` returns to. Replaces any previous constraints.
+   */
+  setConstraints(constraints: ViewerOptionsConstraints): void;
+  /** True when the host locked `<group>.<key>`. */
+  isLocked(group: ViewerOptionsGroupId, key: string): boolean;
+}
+//#endregion
+//#region src/render/customization/customization-keymap.d.ts
+/** A parsed `Mod+Shift+D` chord. */
+interface ParsedShortcutChord {
+  key: string;
+  mod: boolean;
+  ctrl: boolean;
+  meta: boolean;
+  alt: boolean;
+  shift: boolean;
+}
+/** The normalised keyboard slice of a resolved customisation. */
+interface ResolvedKeyboardCustomization {
+  disableAll: boolean;
+  disabled: ReadonlySet<EditorKeyActionName>;
+  remap: ReadonlyMap<EditorKeyActionName, readonly ParsedShortcutChord[]>;
+}
+//#endregion
+//#region src/render/customization/customization-resolve.d.ts
+/** The normalised, set-based view of a customisation. Treat as immutable. */
+interface ResolvedCustomization {
+  hiddenActions: ReadonlySet<ToolbarActionId>;
+  hiddenOptionsPages: ReadonlySet<OptionsPageId>;
+  hiddenOptionsSections: ReadonlySet<OptionsSectionId>;
+  hiddenSettings: ReadonlySet<OptionsSettingId>;
+  lockedSettings: OptionsSettingValues;
+  defaultSettings: OptionsSettingValues;
+  hiddenBackstagePages: ReadonlySet<BackstagePage>;
+  hiddenBackstageCards: ReadonlySet<BackstageCardId>;
+  hiddenElementCommands: ReadonlySet<ContextMenuCommandId>;
+  hiddenCanvasCommands: ReadonlySet<CanvasContextMenuCommandId>;
+  elementMenuEnabled: boolean;
+  canvasMenuEnabled: boolean;
+  hiddenPanels: ReadonlySet<ViewerPanelId>;
+  disabledFeatures: ReadonlySet<ViewerFeatureId>;
+  hiddenDialogs: ReadonlySet<ViewerDialogId>;
+  keyboard: ResolvedKeyboardCustomization;
+}
+//#endregion
+//#region src/render/customization/customization-controller.d.ts
+/** The imperative methods every binding's component handle exposes. */
+interface ViewerCustomizationApi {
+  /** The current customisation object (a snapshot; do not mutate). */
+  getCustomization(): ViewerCustomization;
+  /** Replace the whole customisation. */
+  setCustomization(next: ViewerCustomization): void;
+  /** Merge a partial customisation (see `mergeCustomization`). */
+  updateCustomization(patch: ViewerCustomization): void;
+  /** Drop every customisation, back to the stock UI. */
+  resetCustomization(): void;
+  hideRibbonTab(tab: ToolbarTabId): void;
+  showRibbonTab(tab: ToolbarTabId): void;
+  hideToolbarButton(button: ToolbarButtonId): void;
+  showToolbarButton(button: ToolbarButtonId): void;
+  hideOptionsPage(page: OptionsPageId): void;
+  showOptionsPage(page: OptionsPageId): void;
+  hideOptionsSection(section: OptionsSectionId): void;
+  showOptionsSection(section: OptionsSectionId): void;
+  hideSetting(setting: OptionsSettingId): void;
+  showSetting(setting: OptionsSettingId): void;
+  /** Pin a setting to `value`; `hidden` also removes it from the dialog. */
+  lockSetting(setting: OptionsSettingId, value: ViewerOptionPrimitive, hidden?: boolean): void;
+  unlockSetting(setting: OptionsSettingId): void;
+  /** Set (or with `undefined`, clear) the host default for a setting. */
+  setSettingDefault(setting: OptionsSettingId, value: ViewerOptionPrimitive | undefined): void;
+  hideBackstagePage(page: BackstagePage): void;
+  showBackstagePage(page: BackstagePage): void;
+  hideBackstageCard(card: BackstageCardId): void;
+  showBackstageCard(card: BackstageCardId): void;
+  hideContextMenuCommand(command: ContextMenuCommandId): void;
+  showContextMenuCommand(command: ContextMenuCommandId): void;
+  hideCanvasContextMenuCommand(command: CanvasContextMenuCommandId): void;
+  showCanvasContextMenuCommand(command: CanvasContextMenuCommandId): void;
+  disableShortcut(action: EditorKeyActionName): void;
+  enableShortcut(action: EditorKeyActionName): void;
+  /** Move a command onto new chord(s); `undefined` restores the built-in chord. */
+  remapShortcut(action: EditorKeyActionName, chords: ShortcutChord | readonly ShortcutChord[] | undefined): void;
+  setPanelVisible(panel: ViewerPanelId, visible: boolean): void;
+  setFeatureEnabled(feature: ViewerFeatureId, enabled: boolean): void;
+  setDialogAvailable(dialog: ViewerDialogId, available: boolean): void;
 }
 type ReadOnlyRecommendationKind = 'modifyVerifier' | 'markedFinal' | null;
 interface ReadOnlyRecommendation {
@@ -14159,7 +14415,7 @@ interface AccessibilityIssue {
   severity: 'error' | 'warning' | 'info';
   message: string;
 }
-interface PowerPointViewerHandle extends FileViewerHandle, PowerPointViewerAPI {
+interface PowerPointViewerHandle extends FileViewerHandle, PowerPointViewerAPI, ViewerCustomizationApi {
   getContent: () => Promise<Uint8Array>;
 }
 
@@ -14792,6 +15048,8 @@ interface UseFindReplaceInput {
   onSetSelectedElementId: (id: string | null) => void;
   onUpdateSlides: (updater: (slides: PptxSlide[]) => PptxSlide[]) => void;
   onMarkDirty: () => void;
+  /** Host keyboard customisation (disabled / remapped Find shortcuts). */
+  keyboard?: ResolvedKeyboardCustomization;
 }
 interface UseFindReplaceResult {
   findReplaceOpen: boolean;
@@ -14809,7 +15067,7 @@ interface UseFindReplaceResult {
   handleReplace: () => void;
   handleReplaceAll: () => void;
 }
-declare function useFindReplace({ slides, mode, onSetActiveSlideIndex, onSetSelectedElementId, onUpdateSlides, onMarkDirty }: UseFindReplaceInput): UseFindReplaceResult;
+declare function useFindReplace({ slides, mode, onSetActiveSlideIndex, onSetSelectedElementId, onUpdateSlides, onMarkDirty, keyboard }: UseFindReplaceInput): UseFindReplaceResult;
 //#endregion
 //#region src/viewer/components/hyperlink-edit-types.d.ts
 /** The type of hyperlink target. */
@@ -15814,6 +16072,8 @@ interface UseEditorOperationsInput {
   handlerRef?: React$1.RefObject<PptxHandler | null> | React$1.MutableRefObject<PptxHandler | null>;
   /** AutoCorrect transform applied to committed inline text edits. */
   transformCommittedText?: (text: string) => string;
+  /** Host keyboard customisation, forwarded to the Find shortcut. */
+  keyboard?: ResolvedKeyboardCustomization;
 }
 interface EditorOperationsResult {
   ops: ElementOperations;
@@ -17395,6 +17655,8 @@ interface UseKeyboardShortcutWiringInput {
   pasteFormatToSelection: (targetIds: string[]) => void;
   /** Ctrl/Cmd+Alt+V: open the Paste Special dialog. */
   onPasteSpecial: () => void;
+  /** Host UI customisation forwarded to `useKeyboardShortcuts`. */
+  customization?: ResolvedCustomization;
 }
 declare function useKeyboardShortcutWiring(input: UseKeyboardShortcutWiringInput): void;
 //#endregion
@@ -17474,6 +17736,10 @@ interface UseViewerIntegrationInput {
   onZoomChange: ((zoom: number) => void) | undefined;
   onSelectionChange: ((ids: string[]) => void) | undefined;
   onSlideCountChange: ((count: number) => void) | undefined;
+  /** Host UI customisation helpers, spread onto the imperative handle. */
+  customizationApi?: ViewerCustomizationApi;
+  /** Resolved host UI customisation, read by the keyboard shortcuts. */
+  customization?: ResolvedCustomization;
 }
 interface ViewerIntegrationResult {
   exportHandlers: IOHandlersResult['exportHandlers'];
@@ -17874,6 +18140,11 @@ interface UseKeyboardShortcutsInput {
   activeTool: DrawingTool;
   /** Whether at least one element is selected. */
   hasSelection: boolean;
+  /**
+   * Host UI customisation: disabled / remapped editor shortcuts, and the
+   * `presentMode` feature gate for F5 / Shift+F5. Omitted customises nothing.
+   */
+  customization?: ResolvedCustomization;
   /** The IDs of the currently selected elements (effective). */
   effectiveSelectedIds: string[];
   onDelete: () => void;