pptx-react-viewer 4.49.0 → 4.51.0

package/dist/viewer/index.d.ts

@@ -2,7 +2,7 @@ import * as ooxml_ui_pptx from 'ooxml-ui/pptx';
 import { CollaborationRole, CollaborationConfig, ViewportFitOptions, ViewerFontSource, CanvasSize, DocumentStorage, ViewerAutosaveStatus, AutosaveRecord, ConnectionStatus, ViewerTheme, ThemeCatalogEntry, AccountAuthConfig, CollaborationInput, ToolbarActionId, RibbonAddInTab, ViewerCustomization, PowerPointViewerAPI, ViewerCustomizationApi, BorrowedCollaborationAwareness } from 'ooxml-ui/pptx';
 export { CollaborationConfig, CollaborationRole, ElementClipboardPayload, ExternalCollaborationAwareness, ExternalCollaborationSession, ExternalCollaborationSnapshot, SessionDeck, ShapeAdjustmentDragState, ShapeAdjustmentHandleDescriptor, ViewerMode, clearAudienceContent, forgetSessionDeck, getSessionTabId, loadAudienceContent, loadSessionDeck, rememberSessionDeck, restoreSessionDeck, storeAudienceContent } from 'ooxml-ui/pptx';
 import * as React from 'react';
-import React__default, { RefObject } from 'react';
+import React__default, { ReactNode, ReactElement, RefObject } from 'react';
 import { LocaleCatalogEntry } from 'ooxml-ui/pptx/i18n';
 import { PptxAnimationPreset, ConnectorArrowType, PptxSlide, PptxElement, XmlObject, PptxCoreProperties, PptxElementAnimation, ShapeStyle, PptxSlideTransition, StrokeDashType, PptxNativeAnimation, PptxThemePreset, PptxThemeColorScheme, PptxThemeFontScheme, PptxHandler, PptxData } from 'ooxml-core/pptx';
 import { CollaborationWriteBackState, CollaborationState } from 'ooxml-core/collab';
@@ -480,21 +480,21 @@ interface PowerPointViewerProps extends ViewportFitOptions {
    */
   onThemeChange?: (key: string) => void;
   /**
-   * Initial locale code for File > Options > Language. Falls back to a
-   * persisted `localStorage` choice, then `'en'`.
+   * Initial locale code for File > Options > Language. Falls back to a persisted `localStorage`
+   * choice, then `'en'`. Ignored inside a `PptxI18nProvider`, whose `locale` is the language.
    */
   defaultLocale?: string;
   /**
-   * Locale choices offered by File > Options > Language. Defaults to the
-   * codes actually registered on the host's `react-i18next` instance
-   * (mapped through the shared `LOCALE_CATALOG` for display labels).
+   * Locale choices offered by File > Options > Language. Defaults to the codes registered on the
+   * host's `react-i18next` instance. Inside a `PptxI18nProvider` there is no default: pass two or
+   * more, together with `onLocaleChange`, to show the Language category.
    */
   availableLocales?: LocaleCatalogEntry[];
   /**
-   * Called when the user picks a language from File > Options > Language.
-   * When provided, the host owns applying and persisting the choice (the
-   * viewer will not call `i18n.changeLanguage` or touch `localStorage`
-   * itself); otherwise the viewer applies and persists it directly.
+   * Called when the user picks a language from File > Options > Language. When provided, the
+   * host owns applying and persisting the choice; otherwise the viewer applies and persists it
+   * itself. Inside a `PptxI18nProvider` the host always owns the language: without this callback
+   * the Language category is left out.
    */
   onLocaleChange?: (code: string) => void;
   /**
@@ -724,6 +724,45 @@ declare function getAnimationInitialStyle(preset: PptxAnimationPreset | undefine
  * access (e.g. serialising the current content for saving).
  */
 declare const PowerPointViewer: React.ForwardRefExoticComponent<PowerPointViewerProps & React.RefAttributes<PowerPointViewerHandle>>;
+//#endregion
+//#region src/viewer/i18n/types.d.ts
+/** What the viewer passes `translate`: exactly the params of the call. */
+interface PptxTranslateParams {
+  readonly defaultValue?: string;
+  readonly count?: number;
+  readonly [name: string]: unknown;
+}
+/**
+ * A host translator for {@link PptxI18nProvider}: the text for a viewer key (`pptx.*`) in the
+ * host's active language. Return the key itself, an empty string, `null` or `undefined` for "no
+ * translation": the viewer then shows its built-in English text.
+ */
+type PptxTranslate = (key: string, params?: PptxTranslateParams) => string | null | undefined;
+//#endregion
+//#region src/viewer/i18n/provider.d.ts
+interface PptxI18nProviderProps {
+  /**
+   * Translates a viewer key; see {@link PptxTranslate}. Keep it referentially stable (a
+   * module-level function or `useCallback`): the viewer re-translates, re-rendering and re-running
+   * every translated effect, whenever `translate` or `locale` changes. To pick up messages loaded
+   * later for the same language, pass a new function.
+   */
+  readonly translate: PptxTranslate;
+  /**
+   * The host's active language: what the viewer reports and File > Options > Language shows as
+   * selected. A change re-translates the viewer, also when `translate` stays the same.
+   */
+  readonly locale: string;
+  readonly children?: ReactNode;
+}
+/**
+ * Translates every viewer component below it (`PowerPointViewer` and the standalone building
+ * blocks) through the host's own i18n library instead of react-i18next. A `PowerPointViewer`
+ * reads the provider nearest above it; a provider rendered inside the viewer is ignored, so the
+ * whole viewer shares one language. React only: the other bindings translate through their
+ * framework's i18n library or a `messages` dictionary.
+ */
+declare function PptxI18nProvider({ translate, locale, children }: PptxI18nProviderProps): ReactElement;
 
 //#region src/viewer/hooks/useThemeSwitching.d.ts
 interface UseThemeSwitchingInput {
@@ -912,7 +951,7 @@ interface UseYjsProviderInput {
   config?: CollaborationConfig;
 }
 interface UseYjsProviderResult {
-  /** Current WebSocket connection status. */
+  /** Current connection status. */
   status: ConnectionStatus$1;
   /** The Yjs awareness instance (null until connected). */
   awareness: Awareness | null;
@@ -924,24 +963,19 @@ interface UseYjsProviderResult {
    * Whether the provider completed its initial document sync. Local doc
    * writes should be gated on this so a late joiner never seeds its
    * bootstrap deck into a room whose content has not arrived yet. Websocket
-   * flips it on the provider's 'synced' event; webrtc flips it on peer sync
-   * or after {@link INITIAL_SYNC_GRACE_MS} (a lone fresh-room peer never
-   * receives a sync event).
+   * flips it on the provider's sync event; webrtc on peer sync or after the
+   * grace period (a lone fresh-room peer never receives a sync event).
    */
   synced: boolean;
   /** Manually retry the connection after a timeout or error. */
   retry: () => void;
 }
 /**
- * Lazily loads `yjs` and `y-websocket`, creates a Y.Doc and
- * WebSocketProvider, and tracks the connection lifecycle.
- *
- * If the connection does not succeed within {@link CONNECTION_TIMEOUT_MS},
- * the provider is torn down and status moves to `'error'`. The consumer
- * can call `retry()` to attempt a fresh connection.
+ * Lazily loads `yjs` and the transport, creates a Y.Doc and provider, and
+ * tracks the connection lifecycle through the shared session controller.
+ * The Yjs packages are dynamically imported so they are fully tree-shaken
+ * when collaboration is not enabled.
  *
- * The Yjs packages are dynamically imported so they are fully
- * tree-shaken when collaboration is not enabled.
  * This low-level hook owns built-in transports only. Use useCollaborativeState
  * (or the full/headless viewer) to attach a host-owned external session.
  */
@@ -1066,5 +1100,5 @@ interface CollaborationStatusIndicatorProps {
 }
 declare function CollaborationStatusIndicator({ status, connectedCount, onRetry }: CollaborationStatusIndicatorProps): React__default.ReactElement;
 
-export { CollaborationProvider, CollaborationStatusIndicator, PowerPointViewer, RemoteUserCursors, UserAvatarBar, getAnimationInitialStyle, isAudienceTab, parseAudienceNonce, useCollaborativeHistory, useCollaborativeState, usePresenceTracking, useThemeSwitching, useYjsProvider };
-export type { AccessibilityIssue, AnimationPresetOption, CanvasContextMenuState, CanvasSize$1 as CanvasSize, CollaborationContextValue, CollaborationStatusIndicatorProps, ConnectionStatus$1 as ConnectionStatus, ConnectorArrowOption, ConnectorGeometryOption, ConnectorGeometryType, ConnectorPathGeometry, DragState, DrawingTool, EditorHistorySnapshot, ElementBounds, ElementContextMenuAction, ElementContextMenuState, FileViewerHandle, MarqueeSelectionState, ParsedTableCell, ParsedTableData, PowerPointViewerHandle, PowerPointViewerProps, PresentationAnimationRuntime, RemoteUserCursorsProps, ResizeHandle, ResizeState, ShapePreset, ShapeQuickStyle, ShortcutReferenceItem, SlideAlignment, SlideSectionGroup, SlideTransitionOption, StrokeDashOption, SupportedShapeType, TableCellEditorState, ThemeSwitchingResult, ToolbarSection, UseCollaborativeHistoryResult, UseCollaborativeStateInput, UsePresenceTrackingResult, UseThemeSwitchingInput, UserAvatarBarProps, UserPresence };
+export { CollaborationProvider, CollaborationStatusIndicator, PowerPointViewer, PptxI18nProvider, RemoteUserCursors, UserAvatarBar, getAnimationInitialStyle, isAudienceTab, parseAudienceNonce, useCollaborativeHistory, useCollaborativeState, usePresenceTracking, useThemeSwitching, useYjsProvider };
+export type { AccessibilityIssue, AnimationPresetOption, CanvasContextMenuState, CanvasSize$1 as CanvasSize, CollaborationContextValue, CollaborationStatusIndicatorProps, ConnectionStatus$1 as ConnectionStatus, ConnectorArrowOption, ConnectorGeometryOption, ConnectorGeometryType, ConnectorPathGeometry, DragState, DrawingTool, EditorHistorySnapshot, ElementBounds, ElementContextMenuAction, ElementContextMenuState, FileViewerHandle, MarqueeSelectionState, ParsedTableCell, ParsedTableData, PowerPointViewerHandle, PowerPointViewerProps, PptxI18nProviderProps, PptxTranslate, PptxTranslateParams, PresentationAnimationRuntime, RemoteUserCursorsProps, ResizeHandle, ResizeState, ShapePreset, ShapeQuickStyle, ShortcutReferenceItem, SlideAlignment, SlideSectionGroup, SlideTransitionOption, StrokeDashOption, SupportedShapeType, TableCellEditorState, ThemeSwitchingResult, ToolbarSection, UseCollaborativeHistoryResult, UseCollaborativeStateInput, UsePresenceTrackingResult, UseThemeSwitchingInput, UserAvatarBarProps, UserPresence };

package/dist/viewer/index.js

@@ -1,8 +1,8 @@
 'use strict';
 
-var chunk2ZXXHNNR_js = require('../chunk-2ZXXHNNR.js');
-var chunkME5QRTVS_js = require('../chunk-ME5QRTVS.js');
-var chunkJAI42EXQ_js = require('../chunk-JAI42EXQ.js');
+var chunkVI5DQRQZ_js = require('../chunk-VI5DQRQZ.js');
+var chunkV3XADJ2O_js = require('../chunk-V3XADJ2O.js');
+var chunkZ22RD3E2_js = require('../chunk-Z22RD3E2.js');
 require('../chunk-PIRHQTI4.js');
 var pptx = require('ooxml-ui/pptx');
 
@@ -10,67 +10,71 @@ var pptx = require('ooxml-ui/pptx');
 
 Object.defineProperty(exports, "CollaborationStatusIndicator", {
   enumerable: true,
-  get: function () { return chunk2ZXXHNNR_js.CollaborationStatusIndicator; }
+  get: function () { return chunkVI5DQRQZ_js.CollaborationStatusIndicator; }
 });
 Object.defineProperty(exports, "PowerPointViewer", {
   enumerable: true,
-  get: function () { return chunk2ZXXHNNR_js.PowerPointViewer; }
+  get: function () { return chunkVI5DQRQZ_js.PowerPointViewer; }
+});
+Object.defineProperty(exports, "PptxI18nProvider", {
+  enumerable: true,
+  get: function () { return chunkVI5DQRQZ_js.PptxI18nProvider; }
 });
 Object.defineProperty(exports, "UserAvatarBar", {
   enumerable: true,
-  get: function () { return chunk2ZXXHNNR_js.UserAvatarBar; }
+  get: function () { return chunkVI5DQRQZ_js.UserAvatarBar; }
 });
 Object.defineProperty(exports, "CollaborationProvider", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.CollaborationProvider; }
+  get: function () { return chunkV3XADJ2O_js.CollaborationProvider; }
 });
 Object.defineProperty(exports, "RemoteUserCursors", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.RemoteUserCursors; }
+  get: function () { return chunkV3XADJ2O_js.RemoteUserCursors; }
 });
 Object.defineProperty(exports, "clearAudienceContent", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.clearAudienceContent; }
+  get: function () { return chunkV3XADJ2O_js.clearAudienceContent; }
 });
 Object.defineProperty(exports, "isAudienceTab", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.isAudienceTab; }
+  get: function () { return chunkV3XADJ2O_js.isAudienceTab; }
 });
 Object.defineProperty(exports, "loadAudienceContent", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.loadAudienceContent; }
+  get: function () { return chunkV3XADJ2O_js.loadAudienceContent; }
 });
 Object.defineProperty(exports, "parseAudienceNonce", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.parseAudienceNonce; }
+  get: function () { return chunkV3XADJ2O_js.parseAudienceNonce; }
 });
 Object.defineProperty(exports, "storeAudienceContent", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.storeAudienceContent; }
+  get: function () { return chunkV3XADJ2O_js.storeAudienceContent; }
 });
 Object.defineProperty(exports, "useCollaborativeHistory", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.useCollaborativeHistory; }
+  get: function () { return chunkV3XADJ2O_js.useCollaborativeHistory; }
 });
 Object.defineProperty(exports, "useCollaborativeState", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.useCollaborativeState; }
+  get: function () { return chunkV3XADJ2O_js.useCollaborativeState; }
 });
 Object.defineProperty(exports, "usePresenceTracking", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.usePresenceTracking; }
+  get: function () { return chunkV3XADJ2O_js.usePresenceTracking; }
 });
 Object.defineProperty(exports, "useThemeSwitching", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.useThemeSwitching; }
+  get: function () { return chunkV3XADJ2O_js.useThemeSwitching; }
 });
 Object.defineProperty(exports, "useYjsProvider", {
   enumerable: true,
-  get: function () { return chunkME5QRTVS_js.useYjsProvider; }
+  get: function () { return chunkV3XADJ2O_js.useYjsProvider; }
 });
 Object.defineProperty(exports, "getAnimationInitialStyle", {
   enumerable: true,
-  get: function () { return chunkJAI42EXQ_js.getAnimationInitialStyle; }
+  get: function () { return chunkZ22RD3E2_js.getAnimationInitialStyle; }
 });
 Object.defineProperty(exports, "forgetSessionDeck", {
   enumerable: true,

package/dist/viewer/index.mjs

@@ -1,5 +1,5 @@
-export { CollaborationStatusIndicator, PowerPointViewer, UserAvatarBar } from '../chunk-YKLL2Z33.mjs';
-export { CollaborationProvider, RemoteUserCursors, clearAudienceContent, isAudienceTab, loadAudienceContent, parseAudienceNonce, storeAudienceContent, useCollaborativeHistory, useCollaborativeState, usePresenceTracking, useThemeSwitching, useYjsProvider } from '../chunk-Z62JFXMZ.mjs';
-export { getAnimationInitialStyle } from '../chunk-PFV626ED.mjs';
+export { CollaborationStatusIndicator, PowerPointViewer, PptxI18nProvider, UserAvatarBar } from '../chunk-ETJ752B5.mjs';
+export { CollaborationProvider, RemoteUserCursors, clearAudienceContent, isAudienceTab, loadAudienceContent, parseAudienceNonce, storeAudienceContent, useCollaborativeHistory, useCollaborativeState, usePresenceTracking, useThemeSwitching, useYjsProvider } from '../chunk-ACFR4LFQ.mjs';
+export { getAnimationInitialStyle } from '../chunk-ZCGYPCZM.mjs';
 import '../chunk-UV2HVMKZ.mjs';
 export { forgetSessionDeck, getSessionTabId, loadSessionDeck, rememberSessionDeck, restoreSessionDeck } from 'ooxml-ui/pptx';

package/dist/{y-webrtc-2H7UYAQD.mjs → y-webrtc-HRGGVQZH.mjs}

@@ -1,4 +1,4 @@
-import { getUnixTime, create2, floor, MAX_SAFE_INTEGER, MIN_SAFE_INTEGER, unexpectedCase, some, isArray, every, every2, create3, fromCharCode, hasProperty, getVariable, nop, equalityDeep, EqualityTraitSymbol, methodUnimplemented, equals, isObject, production, repeat, createEncoder, writeVarUint, writeSyncStep1, writeVarUint8Array, encodeAwarenessUpdate, toUint8Array, writeUpdate, removeAwarenessStates, subscribe, writeSyncStep2, writeUint8, writeVarString, unsubscribe, toBase64, fromBase64, ObservableV2, Awareness, setIfUndefined, createDecoder, readVarString, readVarUint8Array, readVarUint, readUint8, applyAwarenessUpdate, readSyncMessage, messageYjsSyncStep2, publish, writeAny, Observable, readAny, encodeUtf8, supportsColor, create, min, log10, map, messageYjsSyncStep1 } from './chunk-3VVZGHHY.mjs';
+import { getUnixTime, create2, floor, MAX_SAFE_INTEGER, MIN_SAFE_INTEGER, unexpectedCase, some, isArray, every, every2, create3, fromCharCode, hasProperty, getVariable, nop, equalityDeep, EqualityTraitSymbol, methodUnimplemented, equals, isObject, production, repeat, createEncoder, writeVarUint, writeSyncStep1, writeVarUint8Array, encodeAwarenessUpdate, toUint8Array, writeUpdate, removeAwarenessStates, subscribe, writeSyncStep2, writeUint8, writeVarString, unsubscribe, toBase64, fromBase64, ObservableV2, Awareness, setIfUndefined, createDecoder, readVarString, readVarUint8Array, readVarUint, readUint8, applyAwarenessUpdate, readSyncMessage, messageYjsSyncStep2, publish, writeAny, Observable, readAny, encodeUtf8, supportsColor, create, min, log10, map, messageYjsSyncStep1 } from './chunk-QIUK53JR.mjs';
 import { __commonJS, __toESM, __require } from './chunk-UV2HVMKZ.mjs';
 import 'yjs';