pptx-react-viewer 1.1.73 → 1.1.75

package/dist/viewer/index.d.ts

@@ -1,9 +1,9 @@
-import { C as CollaborationConfig, c as ConnectionStatus, U as UserPresence, d as CollaborationContextValue } from '../PowerPointViewer-DSaLy8x5.js';
-export { A as AccessibilityIssue, e as AnimationPresetOption, f as CanvasSize, h as CollaborationRole, i as ConnectorArrowOption, j as ConnectorGeometryOption, k as ConnectorGeometryType, l as ConnectorPathGeometry, D as DragState, m as DrawingTool, E as EditorHistorySnapshot, n as ElementBounds, o as ElementClipboardPayload, p as ElementContextMenuAction, q as ElementContextMenuState, F as FileViewerHandle, M as MarqueeSelectionState, r as ParsedTableCell, s as ParsedTableData, P as PowerPointViewer, a as PowerPointViewerHandle, b as PowerPointViewerProps, t as PresentationAnimationRuntime, R as ResizeHandle, u as ResizeState, S as ShapeAdjustmentDragState, v as ShapeAdjustmentHandleDescriptor, w as ShapePreset, x as ShapeQuickStyle, y as ShortcutReferenceItem, z as SlideAlignment, B as SlideSectionGroup, G as SlideTransitionOption, H as StrokeDashOption, I as SupportedShapeType, T as TableCellEditorState, J as ToolbarSection, V as ViewerMode, g as getAnimationInitialStyle } from '../PowerPointViewer-DSaLy8x5.js';
+import { C as CollaborationRole, c as CollaborationConfig } from '../PowerPointViewer-DNlwKuTs.js';
+export { A as AccessibilityIssue, d as AnimationPresetOption, e as CanvasSize, f as ConnectorArrowOption, h as ConnectorGeometryOption, i as ConnectorGeometryType, j as ConnectorPathGeometry, D as DragState, k as DrawingTool, E as EditorHistorySnapshot, l as ElementBounds, m as ElementClipboardPayload, n as ElementContextMenuAction, o as ElementContextMenuState, F as FileViewerHandle, M as MarqueeSelectionState, p as ParsedTableCell, q as ParsedTableData, P as PowerPointViewer, a as PowerPointViewerHandle, b as PowerPointViewerProps, r as PresentationAnimationRuntime, R as ResizeHandle, s as ResizeState, S as ShapeAdjustmentDragState, t as ShapeAdjustmentHandleDescriptor, u as ShapePreset, v as ShapeQuickStyle, w as ShortcutReferenceItem, x as SlideAlignment, y as SlideSectionGroup, z as SlideTransitionOption, B as StrokeDashOption, G as SupportedShapeType, T as TableCellEditorState, H as ToolbarSection, V as ViewerMode, g as getAnimationInitialStyle } from '../PowerPointViewer-DNlwKuTs.js';
 import { d, e, n, o, m, l, P, X, p, q, r, s, t, u, v, w, x, y, z, A, B, D, E, F, G, H, J, K, L, h, i, k, j, f, g } from './presentation-BRAUjTRt.js';
 import React__default, { RefObject } from 'react';
-import { Awareness } from 'y-protocols/awareness';
 import { Doc } from 'yjs';
+import { Awareness } from 'y-protocols/awareness';
 import './theme/index.js';
 
 /**
@@ -1357,6 +1357,65 @@ declare class PptxHandler extends PptxHandlerCore {
     static create(options?: PresentationOptions): Promise<PresentationBuilderResult>;
 }
 
+/**
+ * Collaboration types: Shared type definitions for the real-time
+ * collaboration infrastructure (Yjs-backed CRDT sync, presence tracking,
+ * collaborative editing).
+ *
+ * @module collaboration/types
+ */
+
+/** Connection lifecycle states for the Yjs WebSocket provider. */
+type ConnectionStatus = 'disconnected' | 'connecting' | 'connected' | 'error';
+/**
+ * Presence data broadcast to other participants.
+ * Cursor position is relative to the slide canvas (0..canvasWidth, 0..canvasHeight).
+ */
+interface UserPresence {
+    /** Unique client ID (assigned by Yjs awareness). */
+    clientId: number;
+    /** Sanitised display name. */
+    userName: string;
+    /** Optional avatar URL (validated). */
+    userAvatar?: string;
+    /** Hex colour for the user's cursor ring. */
+    userColor: string;
+    /** Slide index the user is currently viewing. */
+    activeSlideIndex: number;
+    /** Cursor X on the canvas (clamped to slide bounds). */
+    cursorX: number;
+    /** Cursor Y on the canvas (clamped to slide bounds). */
+    cursorY: number;
+    /** ISO timestamp of last update (for stale-presence cleanup). */
+    lastUpdated: string;
+    /** Optional currently selected element ID. */
+    selectedElementId?: string;
+    /** Role in the session (owner, viewer, or collaborator). */
+    role?: CollaborationRole;
+}
+/** Value exposed by `CollaborationContext`. */
+interface CollaborationContextValue {
+    /** Current WebSocket connection status. */
+    status: ConnectionStatus;
+    /** Presence data for all remote users (excludes the local user). */
+    remoteUsers: UserPresence[];
+    /** Broadcast the local user's presence state. */
+    broadcastPresence: (update: Partial<Omit<UserPresence, 'clientId'>>) => void;
+    /** Total number of connected users (including local). */
+    connectedCount: number;
+    /** The collaboration config that was provided. */
+    config: CollaborationConfig;
+    /** The Yjs document (for document sync). */
+    doc: Doc | null;
+    /**
+     * Whether the provider completed its initial document sync (or the
+     * first-write grace period elapsed). Local doc writes are gated on this.
+     */
+    synced: boolean;
+    /** Manually retry the WebSocket connection after a timeout or error. */
+    retry: () => void;
+}
+
 /** Returns true if the current page was opened as an audience tab. */
 declare function isAudienceTab(): boolean;
 
@@ -1440,10 +1499,13 @@ interface ThemeSwitchingResult {
 declare function useThemeSwitching(input: UseThemeSwitchingInput): ThemeSwitchingResult;
 
 /**
- * useYjsProvider: Manages the Yjs document and WebSocket provider lifecycle.
+ * useYjsProvider: Manages the Yjs document and provider lifecycle.
  *
- * Creates a Y.Doc and connects via WebSocketProvider to the collaboration
- * server. Exposes connection status and cleanup on unmount.
+ * Creates a Y.Doc and connects via one of two transports:
+ *  - `websocket` (default): WebSocketProvider against `config.serverUrl`.
+ *  - `webrtc`: peer-to-peer WebrtcProvider (no document server); usable from
+ *    static hosting. Same-browser tabs sync over BroadcastChannel.
+ * Exposes connection status and cleanup on unmount.
  *
  * This hook is intentionally thin: it only manages the transport layer.
  * Application-level collaboration logic lives in useCollaborativeState
@@ -1464,6 +1526,15 @@ interface UseYjsProviderResult {
     doc: Doc | null;
     /** Local awareness client ID. */
     clientId: number | null;
+    /**
+     * 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).
+     */
+    synced: boolean;
     /** Manually retry the connection after a timeout or error. */
     retry: () => void;
 }
@@ -1632,4 +1703,4 @@ interface CollaborationStatusIndicatorProps {
 }
 declare function CollaborationStatusIndicator({ status, connectedCount, onRetry, }: CollaborationStatusIndicatorProps): React__default.ReactElement;
 
-export { CollaborationConfig, CollaborationContextValue, CollaborationProvider, CollaborationStatusIndicator, type CollaborationStatusIndicatorProps, ConnectionStatus, RemoteUserCursors, type RemoteUserCursorsProps, type ThemeSwitchingResult, type UseCollaborativeHistoryResult, type UseCollaborativeStateInput, type UsePresenceTrackingResult, type UseThemeSwitchingInput, UserAvatarBar, type UserAvatarBarProps, UserPresence, clearAudienceContent, isAudienceTab, loadAudienceContent, storeAudienceContent, useCollaborativeHistory, useCollaborativeState, usePresenceTracking, useThemeSwitching, useYjsProvider };
+export { CollaborationConfig, type CollaborationContextValue, CollaborationProvider, CollaborationRole, CollaborationStatusIndicator, type CollaborationStatusIndicatorProps, type ConnectionStatus, RemoteUserCursors, type RemoteUserCursorsProps, type ThemeSwitchingResult, type UseCollaborativeHistoryResult, type UseCollaborativeStateInput, type UsePresenceTrackingResult, type UseThemeSwitchingInput, UserAvatarBar, type UserAvatarBarProps, type UserPresence, clearAudienceContent, isAudienceTab, loadAudienceContent, storeAudienceContent, useCollaborativeHistory, useCollaborativeState, usePresenceTracking, useThemeSwitching, useYjsProvider };