@bendyline/squisq-react 0.1.2 → 1.0.1

package/dist/DocPlayer.d.ts

@@ -0,0 +1,87 @@
+/**
+ * DocPlayer Component
+ *
+ * Main component for playing visual stories. Combines audio playback
+ * with synchronized SVG block animations. Supports both interactive
+ * browser playback and headless rendering for video export.
+ *
+ * Features:
+ * - Audio synchronization with multiple MP3 segments
+ * - Block transitions (fade, dissolve, slide)
+ * - Playback controls (play/pause, seek, next/prev)
+ * - Progress display
+ * - Render mode for video capture (via window.seekTo)
+ * - Pluggable audio provider for different environments (browser, EFB)
+ * - Multiple control layouts: overlay (default), sidebar, bottom
+ *
+ * Related Files:
+ * - DocControlsOverlay.tsx -- Default overlay controls
+ * - DocProgressBar.tsx -- Extracted progress bar
+ * - DocControlsSidebar.tsx -- Vertical sidebar controls
+ * - DocPlayerWithSidebar.tsx -- Wrapper for sidebar layout
+ * - types.ts -- Shared control types
+ */
+import type { Doc } from '@bendyline/squisq/schemas';
+import type { Theme } from '@bendyline/squisq/schemas';
+import type { AudioProvider } from './hooks/AudioProvider';
+import { type ViewportConfig } from '@bendyline/squisq/doc';
+import type { PlaybackState, PlaybackActions, BlockMarker, DisplayMode } from './types';
+interface DocPlayerProps {
+    /** Doc script to play */
+    script: Doc;
+    /** Base path for resolving media URLs */
+    basePath: string;
+    /** Render mode for video capture (hides controls, exposes seekTo) */
+    renderMode?: boolean;
+    /** Auto-play when loaded */
+    autoPlay?: boolean;
+    /** Callback when playback ends */
+    onEnded?: () => void;
+    /** Callback for time updates */
+    onTimeUpdate?: (time: number) => void;
+    /** Optional audio provider (if not provided, uses default HTML5 audio) */
+    audioProvider?: AudioProvider;
+    /** Show built-in controls (default: true). Set to false for custom controls. */
+    showControls?: boolean;
+    /** Show only the progress bar/scrubber at bottom (no other controls).
+     *  Only takes effect when showControls is false. Allows external controls
+     *  while keeping the scrubber in-video. */
+    showScrubber?: boolean;
+    /** Mute audio (default: false) */
+    muted?: boolean;
+    /** Enable captions (default: true) */
+    captionsEnabled?: boolean;
+    /** Callback when captions enabled state is toggled */
+    onCaptionsToggle?: (enabled: boolean) => void;
+    /** Callback for playback state changes (for external controls) */
+    onPlaybackStateChange?: (state: PlaybackState) => void;
+    /** Callback when playback controls are ready (for external controls) */
+    onControlsReady?: (controls: PlaybackActions & {
+        play: () => void;
+        pause: () => void;
+    }) => void;
+    /** Whether the player is currently in fullscreen mode */
+    isFullscreen?: boolean;
+    /** Callback to toggle fullscreen mode */
+    onFullscreenToggle?: () => void;
+    /** Callback when block markers are computed (for external progress bars) */
+    onBlockMarkers?: (markers: BlockMarker[]) => void;
+    /** Force a specific viewport preset, bypassing window-based orientation detection.
+     *  Used when the player is rendered in a constrained container (e.g., map overlay panel)
+     *  whose shape differs from the window's. */
+    forceViewport?: ViewportConfig;
+    /** Theme to use for rendering (default: DEFAULT_THEME from the theme library) */
+    theme?: Theme;
+    /**
+     * Display mode for the player.
+     * - `'video'` (default) — Traditional video playback with play/pause, scrub bar, auto-advance.
+     * - `'slideshow'` — PowerPoint-style with prev/next buttons. Blocks are static slides
+     *   that only change on user click. No auto-advance, no scrub bar.
+     * - `'linear'` — Long-scrolling document view. Renders markdown as readable HTML with
+     *   template-annotated sections as inline SVG cards. No audio, no timeline.
+     */
+    displayMode?: DisplayMode;
+}
+export declare function DocPlayer({ script, basePath, renderMode, autoPlay, onEnded, onTimeUpdate, audioProvider: externalAudioProvider, showControls, showScrubber, muted, captionsEnabled: captionsEnabledProp, onCaptionsToggle, onPlaybackStateChange, onControlsReady, isFullscreen, onFullscreenToggle, onBlockMarkers, forceViewport, displayMode, theme, }: DocPlayerProps): import("react/jsx-runtime").JSX.Element;
+export default DocPlayer;
+//# sourceMappingURL=DocPlayer.d.ts.map

package/dist/DocPlayer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocPlayer.d.ts","sourceRoot":"","sources":["../src/DocPlayer.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAGH,OAAO,KAAK,EAAE,GAAG,EAAgD,MAAM,2BAA2B,CAAC;AAEnG,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAMvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAKL,KAAK,cAAc,EACpB,MAAM,uBAAuB,CAAC;AAK/B,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,WAAW,EACX,WAAW,EAGZ,MAAM,SAAS,CAAC;AA8DjB,UAAU,cAAc;IACtB,yBAAyB;IACzB,MAAM,EAAE,GAAG,CAAC;IACZ,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,gCAAgC;IAChC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,0EAA0E;IAC1E,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,gFAAgF;IAChF,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;+CAE2C;IAC3C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kCAAkC;IAClC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,sCAAsC;IACtC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,sDAAsD;IACtD,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAC9C,kEAAkE;IAClE,qBAAqB,CAAC,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;IACvD,wEAAwE;IACxE,eAAe,CAAC,EAAE,CAChB,QAAQ,EAAE,eAAe,GAAG;QAC1B,IAAI,EAAE,MAAM,IAAI,CAAC;QACjB,KAAK,EAAE,MAAM,IAAI,CAAC;KACnB,KACE,IAAI,CAAC;IACV,yDAAyD;IACzD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,yCAAyC;IACzC,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAC;IAChC,4EAA4E;IAC5E,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,IAAI,CAAC;IAClD;;iDAE6C;IAC7C,aAAa,CAAC,EAAE,cAAc,CAAC;IAC/B,iFAAiF;IACjF,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,wBAAgB,SAAS,CAAC,EACxB,MAAM,EACN,QAAQ,EACR,UAAkB,EAClB,QAAgB,EAChB,OAAO,EACP,YAAY,EACZ,aAAa,EAAE,qBAAqB,EACpC,YAAmB,EACnB,YAAoB,EACpB,KAAa,EACb,eAAe,EAAE,mBAAmB,EACpC,gBAAgB,EAChB,qBAAqB,EACrB,eAAe,EACf,YAAoB,EACpB,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,WAAqB,EACrB,KAAK,GACN,EAAE,cAAc,2CAwyBhB;AAED,eAAe,SAAS,CAAC"}