@bendyline/squisq-react 2.4.0 → 2.4.1

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { SquisqRenderAPI } from './player/index.js';
-export { BlockMarker, BlockRenderer, CaptionMode, CaptionOverlay, CaptionStyle, ControlsLayout, DisplayMode, DocControlsBottom, DocControlsOverlay, DocControlsSidebar, DocControlsSlideshow, DocPlayer, DocPlayerProps, DocPlayerWithSidebar, DocProgressBar, InlineAudioPlayer, InlineAudioPlayerProps, InlineVideoPlayer, InlineVideoPlayerProps, MediaClipLayer, MediaClipLayerProps, PipPosition, PipShape, PlaybackActions, PlaybackState, RenderAudioSegmentInfo, RenderBlockInfo, RenderCaptionInfo, RenderChapterInfo, SlideNavActions, SocialCaptionOverlay, VideoPresentation, formatTime } from './player/index.js';
-import { Theme } from '@bendyline/squisq/schemas';
+import { SquisqRenderAPI, VideoPresentation as VideoPresentation$1, PipSize, PipShape, PipPosition } from './player/index.js';
+export { BlockMarker, BlockRenderer, CaptionMode, CaptionOverlay, CaptionStyle, ControlsLayout, DisplayMode, DocControlsBottom, DocControlsOverlay, DocControlsSidebar, DocControlsSlideshow, DocPlayer, DocPlayerProps, DocPlayerWithSidebar, DocProgressBar, InlineAudioPlayer, InlineAudioPlayerProps, InlineVideoPlayer, InlineVideoPlayerProps, MediaClipLayer, MediaClipLayerProps, PlaybackActions, PlaybackState, RenderAudioSegmentInfo, RenderBlockInfo, RenderCaptionInfo, RenderChapterInfo, SlideNavActions, SocialCaptionOverlay, formatTime } from './player/index.js';
+import { Theme, VideoPresentation, VideoPipSize, VideoPipShape, VideoPipPosition, Doc, ScheduledClip, MediaProvider } from '@bendyline/squisq/schemas';
 export { MarkdownRenderer, MermaidDiagram, MermaidDiagramProps } from './markdown/index.js';
 export { CanvasSection, CanvasSectionProps, ImageDisplayMode, LinearDocView, LinearDocViewProps, PageSectionView, PageSectionViewProps, PageViewContext, PageViewContextValue, usePageView } from './page/index.js';
 export { ImageLayer, MapLayer, MermaidLayer, PathLayer, ShapeLayer, TableLayer, TextLayer, TreeLayer, VideoLayer } from './layers/index.js';
@@ -9,8 +9,8 @@ export { A as AudioActions, a as AudioController, b as AudioState } from './Audi
 export { getAnimationStyle, getTransitionClass } from '@bendyline/squisq/doc';
 export { JsonView, JsonViewProps } from './json-view/index.js';
 import 'react/jsx-runtime';
-import '@bendyline/squisq/markdown';
 import 'react';
+import '@bendyline/squisq/markdown';
 import '@bendyline/squisq/jsonForm';
 
 /**
@@ -54,6 +54,14 @@ interface MountOptions {
     audio?: Record<string, string>;
     /** Optional theme override */
     theme?: Theme;
+    /** Player-level video placement override. Omitted values resolve from the Doc. */
+    videoPresentation?: VideoPresentation;
+    /** Picture-in-picture size override. Omitted values resolve from the Doc. */
+    pipSize?: VideoPipSize;
+    /** Picture-in-picture shape override. Omitted values resolve from the Doc. */
+    pipShape?: VideoPipShape;
+    /** Picture-in-picture corner override. Omitted values resolve from the Doc. */
+    pipPosition?: VideoPipPosition;
     /** Auto-play on mount (only for slideshow mode, default: false) */
     autoPlay?: boolean;
     /**
@@ -87,4 +95,48 @@ interface SquisqPlayerHandle {
     unmount(): void;
 }
 
-export { type MountOptions, type SquisqPlayerHandle, SquisqRenderAPI };
+interface DocPlayerAppearanceOverrides {
+    theme?: Theme;
+    videoPresentation?: VideoPresentation$1;
+    pipSize?: PipSize;
+    pipShape?: PipShape;
+    pipPosition?: PipPosition;
+    showCoverSlide?: boolean;
+}
+interface ResolvedDocPlayerAppearance {
+    theme: Theme;
+    videoPresentation: VideoPresentation$1;
+    pipSize: PipSize;
+    pipShape: PipShape;
+    pipPosition: PipPosition;
+    showCoverSlide: boolean;
+}
+/** Resolve the visual settings a standalone/export player must inherit from its Doc. */
+declare function resolveDocPlayerAppearance(doc: Doc, overrides?: DocPlayerAppearanceOverrides): ResolvedDocPlayerAppearance;
+
+/**
+ * useMediaClipDurations
+ *
+ * Probes the intrinsic (natural) duration of scheduled video clips so the media
+ * schedule can end an unlocked video at its own length instead of holding its
+ * last frame until the timeline ends. Returns a `Map<src, seconds>` keyed by the
+ * clip's raw `src`, suitable for {@link resolveMediaSchedule}'s
+ * `intrinsicDuration` option.
+ *
+ * A media file's real length is not part of the pure `Doc` model, so it can only
+ * be learned in the browser. This hook mirrors {@link useMediaUrl}'s resolution
+ * (MediaProvider → basePath fallback, resource-policy gated), loads metadata from
+ * a throwaway `<video>`, and caches each result by resolved URL for the session.
+ *
+ * Only video clips are probed — an over-scheduled audio clip merely goes silent,
+ * which is not the visible "frozen frame" bug this addresses.
+ */
+
+/**
+ * Probe the intrinsic durations of the video clips in `schedule`. Returns a map
+ * keyed by the clip's raw `src`. Pass the resolved `MediaProvider` explicitly
+ * (editor hosts) or rely on {@link MediaContext} (player hosts) by omitting it.
+ */
+declare function useMediaClipDurations(schedule: ScheduledClip[], basePath: string, mediaProviderOverride?: MediaProvider | null): Map<string, number>;
+
+export { type DocPlayerAppearanceOverrides, type MountOptions, PipPosition, PipShape, PipSize, type ResolvedDocPlayerAppearance, type SquisqPlayerHandle, SquisqRenderAPI, VideoPresentation$1 as VideoPresentation, resolveDocPlayerAppearance, useMediaClipDurations };

package/dist/index.js

@@ -9,8 +9,10 @@ import {
   DocProgressBar,
   MediaClipLayer,
   SocialCaptionOverlay,
-  formatTime
-} from "./chunk-HML6PFH2.js";
+  formatTime,
+  resolveDocPlayerAppearance,
+  useMediaClipDurations
+} from "./chunk-EKD6JMJN.js";
 import {
   BlockRenderer,
   CanvasSection,
@@ -97,9 +99,11 @@ export {
   formatTime,
   getAnimationStyle,
   getTransitionClass,
+  resolveDocPlayerAppearance,
   useAudioSync,
   useAutoSurface,
   useDocPlayback,
+  useMediaClipDurations,
   useMediaProvider,
   useMediaSchedule,
   useMediaUrl,

package/dist/player/index.d.ts

@@ -1,7 +1,8 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { Block, Doc, Theme, SurfaceScheme, Transition, CaptionTrack, ViewportConfig as ViewportConfig$1, ScheduledClip } from '@bendyline/squisq/schemas';
+import { Block, VideoPresentation as VideoPresentation$1, VideoPipSize, VideoPipShape, VideoPipPosition, Doc, Theme, SurfaceScheme, Transition, CaptionTrack, ViewportConfig as ViewportConfig$1, ScheduledClip } from '@bendyline/squisq/schemas';
 import { ViewportConfig } from '@bendyline/squisq/doc';
 import { a as AudioController } from '../AudioController-DwMsPe38.js';
+import { CSSProperties } from 'react';
 
 /**
  * Doc Player Control Types
@@ -26,11 +27,13 @@ type ControlsLayout = 'overlay' | 'sidebar' | 'bottom';
  * `'background'` preserves the legacy full-bleed treatment behind the
  * content. The other variants render above the content for presenter video.
  */
-type VideoPresentation = 'background' | 'full-frame' | 'picture-in-picture';
+type VideoPresentation = VideoPresentation$1;
+/** Size of a picture-in-picture presenter video. */
+type PipSize = VideoPipSize;
 /** Shape of a picture-in-picture presenter video. */
-type PipShape = 'square' | 'rounded' | 'circle';
+type PipShape = VideoPipShape;
 /** Corner occupied by a picture-in-picture presenter video. */
-type PipPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+type PipPosition = VideoPipPosition;
 /**
  * Display mode for DocPlayer.
  *
@@ -162,7 +165,10 @@ interface RenderChapterInfo {
  * ```
  */
 interface SquisqRenderAPI {
+    /** Seek and resolve only after the requested visual state is capture-ready. */
     seekTo: (time: number) => Promise<void>;
+    /** Timeline time most recently committed to the player DOM. */
+    getRenderedTime: () => number;
     getDuration: () => number;
     getBlocks: () => RenderBlockInfo[];
     getAudioSegments: () => RenderAudioSegmentInfo[];
@@ -223,7 +229,9 @@ interface DocPlayerProps {
      * Defaults to `'background'` for backward compatibility.
      */
     videoPresentation?: VideoPresentation;
-    /** Shape of presenter video in picture-in-picture mode. */
+    /** Size of presenter video in picture-in-picture mode (default `'small'`). */
+    pipSize?: PipSize;
+    /** Shape of presenter video in picture-in-picture mode (default `'square'`). */
     pipShape?: PipShape;
     /** Corner used by presenter video in picture-in-picture mode. */
     pipPosition?: PipPosition;
@@ -430,13 +438,19 @@ interface MediaClipLayerProps {
     muted?: boolean;
     /** Placement of video clips relative to the rendered document. */
     presentation?: VideoPresentation;
-    /** Shape of a picture-in-guide? */
+    /** Size of picture-in-picture video (small or large). */
+    pipSize?: PipSize;
+    /** Shape of picture-in-picture video (square or 16:9 wide). */
     pipShape?: PipShape;
     /** Corner occupied by picture-in-picture video. */
     pipPosition?: PipPosition;
+    /** Orientation of the rendered player viewport. */
+    pipOrientation?: 'landscape' | 'portrait';
+    /** Resolved theme frame applied directly to PIP video during raster capture. */
+    pipFrameStyle?: Pick<CSSProperties, 'border' | 'borderRadius' | 'boxShadow'>;
     /** Honor each scheduled video's authored placement override. Default true. */
     honorClipPresentation?: boolean;
 }
-declare function MediaClipLayer({ schedule, currentTime, isPlaying, basePath, renderMode, muted, presentation, pipShape, pipPosition, honorClipPresentation, }: MediaClipLayerProps): react_jsx_runtime.JSX.Element | null;
+declare function MediaClipLayer({ schedule, currentTime, isPlaying, basePath, renderMode, muted, presentation, pipSize, pipShape, pipPosition, pipOrientation, pipFrameStyle, honorClipPresentation, }: MediaClipLayerProps): react_jsx_runtime.JSX.Element | null;
 
-export { type BlockMarker, BlockRenderer, type CaptionMode, CaptionOverlay, type CaptionStyle, type ControlsLayout, type DisplayMode, DocControlsBottom, DocControlsOverlay, DocControlsSidebar, DocControlsSlideshow, DocPlayer, type DocPlayerProps, DocPlayerWithSidebar, DocProgressBar, InlineAudioPlayer, type InlineAudioPlayerProps, InlineVideoPlayer, type InlineVideoPlayerProps, MediaClipLayer, type MediaClipLayerProps, type PipPosition, type PipShape, type PlaybackActions, type PlaybackState, type RenderAudioSegmentInfo, type RenderBlockInfo, type RenderCaptionInfo, type RenderChapterInfo, type SlideNavActions, SocialCaptionOverlay, type SquisqRenderAPI, type VideoPresentation, formatTime };
+export { type BlockMarker, BlockRenderer, type CaptionMode, CaptionOverlay, type CaptionStyle, type ControlsLayout, type DisplayMode, DocControlsBottom, DocControlsOverlay, DocControlsSidebar, DocControlsSlideshow, DocPlayer, type DocPlayerProps, DocPlayerWithSidebar, DocProgressBar, InlineAudioPlayer, type InlineAudioPlayerProps, InlineVideoPlayer, type InlineVideoPlayerProps, MediaClipLayer, type MediaClipLayerProps, type PipPosition, type PipShape, type PipSize, type PlaybackActions, type PlaybackState, type RenderAudioSegmentInfo, type RenderBlockInfo, type RenderCaptionInfo, type RenderChapterInfo, type SlideNavActions, SocialCaptionOverlay, type SquisqRenderAPI, type VideoPresentation, formatTime };

package/dist/player/index.js

@@ -10,7 +10,7 @@ import {
   MediaClipLayer,
   SocialCaptionOverlay,
   formatTime
-} from "../chunk-HML6PFH2.js";
+} from "../chunk-EKD6JMJN.js";
 import {
   BlockRenderer
 } from "../chunk-M2HEFJZP.js";