pptx-react-viewer 3.20.1 → 3.21.0

package/dist/viewer/index.d.ts

@@ -1,8 +1,8 @@
+import * as Y from 'yjs';
+import { Doc } from 'yjs';
 import * as React from 'react';
 import React__default, { RefObject } from 'react';
 import { LanguageModel, ChatTransport, UIMessage, ToolSet } from 'ai';
-import * as Y from 'yjs';
-import { Doc } from 'yjs';
 
 //#region src/core/types/actions.d.ts
 /**
@@ -11552,6 +11552,61 @@ interface ThemeCatalogEntry {
   theme: ViewerTheme | undefined;
 }
 
+//#region src/render/collaboration-presence.d.ts
+/** Connection lifecycle states for the Yjs WebSocket provider. */
+type ConnectionStatus$1 = 'disconnected' | 'connecting' | 'connected' | 'error';
+//#endregion
+//#region src/render/collaboration-presence-publisher.d.ts
+/**
+ * Structural interface for the lazily-imported Yjs awareness surface. Every
+ * binding's live `y-protocols/awareness` `Awareness` instance satisfies this.
+ */
+interface AwarenessLike {
+  clientID?: number;
+  setLocalStateField: (field: string, value: unknown) => void;
+  getStates: () => Map<number, Record<string, unknown>>;
+  on: (event: string, cb: () => void) => void;
+  off?: (event: string, cb: () => void) => void;
+}
+//#endregion
+//#region src/render/collaboration-external-session.d.ts
+/** Connection state reported by the host, independent of the viewer lifetime. */
+interface ExternalCollaborationSnapshot {
+  status: ConnectionStatus$1;
+  /**
+   * The host has loaded the authoritative document and permits local edits.
+   * Keep true while offline to allow ordinary Yjs offline edits, or set false
+   * to suspend writes until a fresh sync. The viewer never infers this from
+   * `status` and never opens it after a timeout.
+   */
+  synced: boolean;
+}
+/** The public y-protocols Awareness surface needed by a borrowed session. */
+interface ExternalCollaborationAwareness extends AwarenessLike {
+  clientID: number;
+  getLocalState: () => Record<string, unknown> | null;
+  setLocalState: (state: Record<string, unknown> | null) => void;
+  off: (event: string, callback: () => void) => void;
+}
+/**
+ * Host-owned Yjs resources. The host creates, connects and destroys them.
+ * Keep this object and its resources stable for a session; report connection
+ * changes through subscribe instead of replacing the collaboration config.
+ */
+interface ExternalCollaborationSession {
+  readonly doc: Doc;
+  /** Awareness must belong to doc. One viewer publishes slide presence at a time. */
+  readonly awareness: ExternalCollaborationAwareness;
+  getSnapshot: () => ExternalCollaborationSnapshot;
+  /** Subscribe to status or synced changes; return an unsubscribe function. */
+  subscribe: (listener: () => void) => () => void;
+}
+/** Listener/publisher view, deliberately excluding host lifecycle methods. */
+interface BorrowedCollaborationAwareness extends AwarenessLike {
+  clientID: number;
+  off: (event: string, callback: () => void) => void;
+}
+//#endregion
 //#region src/render/element-update-batch.d.ts
 /** A shallow property patch for a top-level element on an ordinary slide. */
 interface ElementUpdate {
@@ -11693,11 +11748,18 @@ interface CollaborationConfig {
   roomId: string;
   /**
    * WebSocket server URL for the Yjs provider (e.g. "wss://collab.example.com").
-   * Ignored (may be empty) when `transport` is `'webrtc'`.
+   * Ignored (may be empty) for `externalSession` or when `transport` is `'webrtc'`.
    */
   serverUrl: string;
   /** Transport to use. Defaults to `'websocket'`. */
   transport?: CollaborationTransport;
+  /**
+   * Use the host's document, awareness and transport instead of creating a
+   * provider. Transport, serverUrl, signaling and authToken are ignored. The
+   * viewer only detaches its listeners and presence on stop; it never destroys
+   * these resources. Keep this object stable and report readiness via subscribe.
+   */
+  externalSession?: ExternalCollaborationSession;
   /**
    * WebRTC signaling server URLs (only used when `transport` is `'webrtc'`).
    * Defaults to y-webrtc's built-in public signaling list. Same-browser tabs
@@ -13017,12 +13079,14 @@ interface UseYjsProviderResult {
  *
  * 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.
  */
-declare function useYjsProvider({ config }: UseYjsProviderInput): UseYjsProviderResult;
+declare function useYjsProvider({ config: inputConfig }: UseYjsProviderInput): UseYjsProviderResult;
 //#endregion
 //#region src/viewer/hooks/collaboration/usePresenceTracking.d.ts
 interface UsePresenceTrackingInput {
-  awareness: Awareness | null;
+  awareness: Awareness | BorrowedCollaborationAwareness | null;
   localClientId: number | null;
   userName: string;
   userColor: string;
@@ -13140,4 +13204,4 @@ interface CollaborationStatusIndicatorProps {
 declare function CollaborationStatusIndicator({ status, connectedCount, onRetry }: CollaborationStatusIndicatorProps): React__default.ReactElement;
 
 export { CollaborationProvider, CollaborationStatusIndicator, PowerPointViewer, RemoteUserCursors, UserAvatarBar, clearAudienceContent, forgetSessionDeck, getAnimationInitialStyle, getSessionTabId, isAudienceTab, loadAudienceContent, loadSessionDeck, parseAudienceNonce, rememberSessionDeck, restoreSessionDeck, storeAudienceContent, useCollaborativeHistory, useCollaborativeState, usePresenceTracking, useThemeSwitching, useYjsProvider };
-export type { AccessibilityIssue, AnimationPresetOption, CanvasSize, CollaborationConfig, CollaborationContextValue, CollaborationRole, CollaborationStatusIndicatorProps, ConnectionStatus, ConnectorArrowOption, ConnectorGeometryOption, ConnectorGeometryType, ConnectorPathGeometry, DragState, DrawingTool, EditorHistorySnapshot, ElementBounds, ElementClipboardPayload, ElementContextMenuAction, ElementContextMenuState, FileViewerHandle, MarqueeSelectionState, ParsedTableCell, ParsedTableData, PowerPointViewerHandle, PowerPointViewerProps, PptxAiBridge, PptxAiConfig, PptxAiConnection, PptxAiContextStrategy, PptxAiToolName, PptxAiWritePolicy, PresentationAnimationRuntime, RemoteUserCursorsProps, ResizeHandle, ResizeState, SessionDeck, ShapeAdjustmentDragState, ShapeAdjustmentHandleDescriptor, ShapePreset, ShapeQuickStyle, ShortcutReferenceItem, SlideAlignment, SlideSectionGroup, SlideTransitionOption, StrokeDashOption, SupportedShapeType, TableCellEditorState, ThemeSwitchingResult, ToolbarSection, UseCollaborativeHistoryResult, UseCollaborativeStateInput, UsePresenceTrackingResult, UseThemeSwitchingInput, UserAvatarBarProps, UserPresence, ViewerMode };
+export type { AccessibilityIssue, AnimationPresetOption, CanvasSize, CollaborationConfig, CollaborationContextValue, CollaborationRole, CollaborationStatusIndicatorProps, ConnectionStatus, ConnectorArrowOption, ConnectorGeometryOption, ConnectorGeometryType, ConnectorPathGeometry, DragState, DrawingTool, EditorHistorySnapshot, ElementBounds, ElementClipboardPayload, ElementContextMenuAction, ElementContextMenuState, ExternalCollaborationAwareness, ExternalCollaborationSession, ExternalCollaborationSnapshot, FileViewerHandle, MarqueeSelectionState, ParsedTableCell, ParsedTableData, PowerPointViewerHandle, PowerPointViewerProps, PptxAiBridge, PptxAiConfig, PptxAiConnection, PptxAiContextStrategy, PptxAiToolName, PptxAiWritePolicy, PresentationAnimationRuntime, RemoteUserCursorsProps, ResizeHandle, ResizeState, SessionDeck, ShapeAdjustmentDragState, ShapeAdjustmentHandleDescriptor, ShapePreset, ShapeQuickStyle, ShortcutReferenceItem, SlideAlignment, SlideSectionGroup, SlideTransitionOption, StrokeDashOption, SupportedShapeType, TableCellEditorState, ThemeSwitchingResult, ToolbarSection, UseCollaborativeHistoryResult, UseCollaborativeStateInput, UsePresenceTrackingResult, UseThemeSwitchingInput, UserAvatarBarProps, UserPresence, ViewerMode };

package/dist/viewer/index.js

@@ -1,10 +1,10 @@
 'use strict';
 
-var chunk2BQKGTIF_js = require('../chunk-2BQKGTIF.js');
-require('../chunk-K7TAGREH.js');
-var chunkML4MTTPV_js = require('../chunk-ML4MTTPV.js');
-var chunkU46O2NL5_js = require('../chunk-U46O2NL5.js');
-var chunkHN5QJSVB_js = require('../chunk-HN5QJSVB.js');
+var chunkM6QJKPU2_js = require('../chunk-M6QJKPU2.js');
+require('../chunk-H7QPQ4OR.js');
+var chunkBFPIMU6Q_js = require('../chunk-BFPIMU6Q.js');
+var chunkSUZIFHXI_js = require('../chunk-SUZIFHXI.js');
+var chunkT6V342NP_js = require('../chunk-T6V342NP.js');
 require('../chunk-M24DEOP6.js');
 require('../chunk-4VNS5WPM.js');
 
@@ -12,85 +12,85 @@ require('../chunk-4VNS5WPM.js');
 
 Object.defineProperty(exports, "CollaborationProvider", {
   enumerable: true,
-  get: function () { return chunk2BQKGTIF_js.CollaborationProvider; }
+  get: function () { return chunkM6QJKPU2_js.CollaborationProvider; }
 });
 Object.defineProperty(exports, "CollaborationStatusIndicator", {
   enumerable: true,
-  get: function () { return chunk2BQKGTIF_js.CollaborationStatusIndicator; }
+  get: function () { return chunkM6QJKPU2_js.CollaborationStatusIndicator; }
 });
 Object.defineProperty(exports, "PowerPointViewer", {
   enumerable: true,
-  get: function () { return chunk2BQKGTIF_js.PowerPointViewer; }
+  get: function () { return chunkM6QJKPU2_js.PowerPointViewer; }
 });
 Object.defineProperty(exports, "RemoteUserCursors", {
   enumerable: true,
-  get: function () { return chunk2BQKGTIF_js.RemoteUserCursors; }
+  get: function () { return chunkM6QJKPU2_js.RemoteUserCursors; }
 });
 Object.defineProperty(exports, "UserAvatarBar", {
   enumerable: true,
-  get: function () { return chunk2BQKGTIF_js.UserAvatarBar; }
+  get: function () { return chunkM6QJKPU2_js.UserAvatarBar; }
 });
 Object.defineProperty(exports, "isAudienceTab", {
   enumerable: true,
-  get: function () { return chunkML4MTTPV_js.isAudienceTab; }
+  get: function () { return chunkBFPIMU6Q_js.isAudienceTab; }
 });
 Object.defineProperty(exports, "parseAudienceNonce", {
   enumerable: true,
-  get: function () { return chunkML4MTTPV_js.parseAudienceNonce; }
+  get: function () { return chunkBFPIMU6Q_js.parseAudienceNonce; }
 });
 Object.defineProperty(exports, "useCollaborativeHistory", {
   enumerable: true,
-  get: function () { return chunkML4MTTPV_js.useCollaborativeHistory; }
+  get: function () { return chunkBFPIMU6Q_js.useCollaborativeHistory; }
 });
 Object.defineProperty(exports, "useCollaborativeState", {
   enumerable: true,
-  get: function () { return chunkML4MTTPV_js.useCollaborativeState; }
+  get: function () { return chunkBFPIMU6Q_js.useCollaborativeState; }
 });
 Object.defineProperty(exports, "usePresenceTracking", {
   enumerable: true,
-  get: function () { return chunkML4MTTPV_js.usePresenceTracking; }
+  get: function () { return chunkBFPIMU6Q_js.usePresenceTracking; }
 });
 Object.defineProperty(exports, "useThemeSwitching", {
   enumerable: true,
-  get: function () { return chunkML4MTTPV_js.useThemeSwitching; }
+  get: function () { return chunkBFPIMU6Q_js.useThemeSwitching; }
 });
 Object.defineProperty(exports, "useYjsProvider", {
   enumerable: true,
-  get: function () { return chunkML4MTTPV_js.useYjsProvider; }
+  get: function () { return chunkBFPIMU6Q_js.useYjsProvider; }
 });
 Object.defineProperty(exports, "getAnimationInitialStyle", {
   enumerable: true,
-  get: function () { return chunkU46O2NL5_js.getAnimationInitialStyle; }
+  get: function () { return chunkSUZIFHXI_js.getAnimationInitialStyle; }
 });
 Object.defineProperty(exports, "clearAudienceContent", {
   enumerable: true,
-  get: function () { return chunkHN5QJSVB_js.clearAudienceContent; }
+  get: function () { return chunkT6V342NP_js.clearAudienceContent; }
 });
 Object.defineProperty(exports, "forgetSessionDeck", {
   enumerable: true,
-  get: function () { return chunkHN5QJSVB_js.forgetSessionDeck; }
+  get: function () { return chunkT6V342NP_js.forgetSessionDeck; }
 });
 Object.defineProperty(exports, "getSessionTabId", {
   enumerable: true,
-  get: function () { return chunkHN5QJSVB_js.getSessionTabId; }
+  get: function () { return chunkT6V342NP_js.getSessionTabId; }
 });
 Object.defineProperty(exports, "loadAudienceContent", {
   enumerable: true,
-  get: function () { return chunkHN5QJSVB_js.loadAudienceContent; }
+  get: function () { return chunkT6V342NP_js.loadAudienceContent; }
 });
 Object.defineProperty(exports, "loadSessionDeck", {
   enumerable: true,
-  get: function () { return chunkHN5QJSVB_js.loadSessionDeck; }
+  get: function () { return chunkT6V342NP_js.loadSessionDeck; }
 });
 Object.defineProperty(exports, "rememberSessionDeck", {
   enumerable: true,
-  get: function () { return chunkHN5QJSVB_js.rememberSessionDeck; }
+  get: function () { return chunkT6V342NP_js.rememberSessionDeck; }
 });
 Object.defineProperty(exports, "restoreSessionDeck", {
   enumerable: true,
-  get: function () { return chunkHN5QJSVB_js.restoreSessionDeck; }
+  get: function () { return chunkT6V342NP_js.restoreSessionDeck; }
 });
 Object.defineProperty(exports, "storeAudienceContent", {
   enumerable: true,
-  get: function () { return chunkHN5QJSVB_js.storeAudienceContent; }
+  get: function () { return chunkT6V342NP_js.storeAudienceContent; }
 });

package/dist/viewer/index.mjs

@@ -1,7 +1,7 @@
-export { CollaborationProvider, CollaborationStatusIndicator, PowerPointViewer, RemoteUserCursors, UserAvatarBar } from '../chunk-GV6LVDBE.mjs';
-import '../chunk-OKIHMWGI.mjs';
-export { isAudienceTab, parseAudienceNonce, useCollaborativeHistory, useCollaborativeState, usePresenceTracking, useThemeSwitching, useYjsProvider } from '../chunk-JIP6BCRV.mjs';
-export { getAnimationInitialStyle } from '../chunk-F65J67TW.mjs';
-export { clearAudienceContent, forgetSessionDeck, getSessionTabId, loadAudienceContent, loadSessionDeck, rememberSessionDeck, restoreSessionDeck, storeAudienceContent } from '../chunk-MWNB4BX5.mjs';
+export { CollaborationProvider, CollaborationStatusIndicator, PowerPointViewer, RemoteUserCursors, UserAvatarBar } from '../chunk-EJMDD4VV.mjs';
+import '../chunk-TOOKJUPG.mjs';
+export { isAudienceTab, parseAudienceNonce, useCollaborativeHistory, useCollaborativeState, usePresenceTracking, useThemeSwitching, useYjsProvider } from '../chunk-BXMPXKV5.mjs';
+export { getAnimationInitialStyle } from '../chunk-HZEOZUUH.mjs';
+export { clearAudienceContent, forgetSessionDeck, getSessionTabId, loadAudienceContent, loadSessionDeck, rememberSessionDeck, restoreSessionDeck, storeAudienceContent } from '../chunk-TMTQJAGK.mjs';
 import '../chunk-R664EPDC.mjs';
 import '../chunk-XGB3TDIC.mjs';