@bendyline/squisq-react 1.3.2 → 1.4.0

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { Block, Doc, Theme, SurfaceScheme, CaptionTrack, ViewportConfig as ViewportConfig$1, ImageLayer as ImageLayer$1, TextLayer as TextLayer$1, ShapeLayer as ShapeLayer$1, VideoLayer as VideoLayer$1, TableLayer as TableLayer$1, MapLayer as MapLayer$1, AudioTrack, MediaProvider } from '@bendyline/squisq/schemas';
+import { Block, Doc, Theme, SurfaceScheme, Transition, CaptionTrack, ViewportConfig as ViewportConfig$1, ImageLayer as ImageLayer$1, TextLayer as TextLayer$1, ShapeLayer as ShapeLayer$1, PathLayer as PathLayer$1, VideoLayer as VideoLayer$1, TableLayer as TableLayer$1, MapLayer as MapLayer$1, ScheduledClip, AudioTrack, MediaProvider } from '@bendyline/squisq/schemas';
 import { ViewportConfig, ViewportOrientation } from '@bendyline/squisq/doc';
 export { getAnimationStyle, getTransitionClass } from '@bendyline/squisq/doc';
-import { MarkdownBlockNode } from '@bendyline/squisq/markdown';
+import { MarkdownBlockNode, HtmlPolicy } from '@bendyline/squisq/markdown';
 import * as react from 'react';
 import { RefObject } from 'react';
 import { SquisqAnnotatedSchema } from '@bendyline/squisq/jsonForm';
@@ -297,12 +297,14 @@ interface BlockRendererProps {
     isEntering?: boolean;
     /** Whether this block is exiting (for transition) */
     isExiting?: boolean;
+    /** Transition to apply. Defaults to block.transition. */
+    transition?: Transition;
     /** Viewport dimensions (defaults to 1920x1080 landscape) */
     viewport?: ViewportDimensions;
     /** Whether the doc is currently playing (controls video playback) */
     isPlaying?: boolean;
 }
-declare function BlockRenderer({ block, blockTime, basePath, isEntering, isExiting, viewport, isPlaying, }: BlockRendererProps): react_jsx_runtime.JSX.Element;
+declare function BlockRenderer({ block, blockTime, basePath, isEntering, isExiting, transition, viewport, isPlaying, }: BlockRendererProps): react_jsx_runtime.JSX.Element;
 
 interface CaptionOverlayProps {
     /** Caption track with timestamped phrases */
@@ -395,6 +397,11 @@ interface MarkdownRendererProps {
     nodes: MarkdownBlockNode[];
     /** Optional CSS class for the wrapper element */
     className?: string;
+    /**
+     * Raw HTML policy. Defaults to `sanitize`, which removes unsafe tags,
+     * event handlers, and executable URL schemes before rendering.
+     */
+    htmlPolicy?: HtmlPolicy;
 }
 /**
  * Renders MarkdownBlockNode[] AST as React HTML elements.
@@ -404,7 +411,7 @@ interface MarkdownRendererProps {
  * <MarkdownRenderer nodes={block.contents} />
  * ```
  */
-declare function MarkdownRenderer({ nodes, className }: MarkdownRendererProps): react_jsx_runtime.JSX.Element | null;
+declare function MarkdownRenderer({ nodes, className, htmlPolicy, }: MarkdownRendererProps): react_jsx_runtime.JSX.Element | null;
 
 interface LinearDocViewProps {
     /** The Doc to render */
@@ -516,7 +523,11 @@ interface TextLayerProps {
     /** Current time relative to block start */
     blockTime: number;
 }
-declare function TextLayer({ layer, viewport, blockTime }: TextLayerProps): react_jsx_runtime.JSX.Element;
+/**
+ * Dispatch between the plain SVG-text renderer and the rich HTML renderer
+ * based on whether the layer carries `content.html`.
+ */
+declare function TextLayer(props: TextLayerProps): react_jsx_runtime.JSX.Element;
 
 interface ShapeLayerProps {
     layer: ShapeLayer$1;
@@ -530,6 +541,18 @@ interface ShapeLayerProps {
 }
 declare function ShapeLayer({ layer, viewport, blockTime }: ShapeLayerProps): react_jsx_runtime.JSX.Element;
 
+interface PathLayerProps {
+    layer: PathLayer$1;
+    /** Viewport dimensions — used to resolve `%` positions for named shapes. */
+    viewport: {
+        width: number;
+        height: number;
+    };
+    /** Current time relative to block start. */
+    blockTime: number;
+}
+declare function PathLayer({ layer, viewport, blockTime }: PathLayerProps): react_jsx_runtime.JSX.Element;
+
 interface VideoLayerProps {
     layer: VideoLayer$1;
     /** Base path for resolving relative video URLs */
@@ -544,7 +567,7 @@ interface VideoLayerProps {
     /** Whether the doc is currently playing */
     isPlaying?: boolean;
 }
-declare function VideoLayer({ layer, basePath, viewport, blockTime: _blockTime, isPlaying, }: VideoLayerProps): react_jsx_runtime.JSX.Element;
+declare function VideoLayer({ layer, basePath, viewport, blockTime, isPlaying }: VideoLayerProps): react_jsx_runtime.JSX.Element;
 
 interface TableLayerProps {
     layer: TableLayer$1;
@@ -572,6 +595,15 @@ interface MapLayerProps {
 }
 declare function MapLayer({ layer, basePath, viewport, blockTime }: MapLayerProps): react_jsx_runtime.JSX.Element;
 
+interface MediaClipLayerProps {
+    schedule: ScheduledClip[];
+    currentTime: number;
+    isPlaying: boolean;
+    basePath: string;
+    renderMode?: boolean;
+}
+declare function MediaClipLayer({ schedule, currentTime, isPlaying, basePath, renderMode, }: MediaClipLayerProps): react_jsx_runtime.JSX.Element | null;
+
 /**
  * useAudioSync Hook
  *
@@ -587,6 +619,30 @@ declare function MapLayer({ layer, basePath, viewport, blockTime }: MapLayerProp
 
 declare function useAudioSync(audioRef: RefObject<HTMLAudioElement>, audioTrack: AudioTrack | undefined, basePath?: string): AudioProvider;
 
+/**
+ * useMediaSchedule
+ *
+ * Pure follower of the playback clock for the media-clip model. Given the
+ * resolved {@link ScheduledClip}s and the current time, it returns the clips
+ * the player should mount and which of them are active right now.
+ * {@link MediaClipLayer} consumes this to drive one hidden `<audio>` /
+ * full-bleed `<video>` element per clip. (Annotation-authored clips all render
+ * at the player level; template-produced `VideoLayer`s are a separate path and
+ * are not part of the schedule.)
+ *
+ * It owns no clock: `currentTime`/`isPlaying` come from the existing
+ * `useAudioSync` provider via `DocPlayer`. With an empty schedule it returns
+ * empty lists, so documents without the new media model are unaffected.
+ */
+
+interface MediaScheduleController {
+    /** Clips the player mounts (every scheduled clip). */
+    renderClips: ScheduledClip[];
+    /** Ids of clips whose [absoluteStart, absoluteEnd) contains currentTime. */
+    activeIds: Set<string>;
+}
+declare function useMediaSchedule(schedule: ScheduledClip[], currentTime: number): MediaScheduleController;
+
 /**
  * useDocPlayback Hook
  *
@@ -707,4 +763,4 @@ interface JsonViewProps {
 }
 declare function JsonView(props: JsonViewProps): react_jsx_runtime.JSX.Element;
 
-export { type AudioActions, type AudioProvider, type AudioState, type BlockMarker, BlockRenderer, type CaptionMode, CaptionOverlay, type CaptionStyle, type ControlsLayout, type DisplayMode, DocControlsBottom, DocControlsOverlay, DocControlsSidebar, DocControlsSlideshow, DocPlayer, DocPlayerWithSidebar, DocProgressBar, type ImageDisplayMode, ImageLayer, InlineAudioPlayer, type InlineAudioPlayerProps, InlineVideoPlayer, type InlineVideoPlayerProps, JsonView, type JsonViewProps, LinearDocView, type LinearDocViewProps, MapLayer, MarkdownRenderer, MediaContext, type PlaybackActions$1 as PlaybackActions, type PlaybackState$1 as PlaybackState, type RenderAudioSegmentInfo, type RenderBlockInfo, type RenderCaptionInfo, type RenderChapterInfo, ShapeLayer, type SlideNavActions, SocialCaptionOverlay, type SquisqRenderAPI, type SquisqWindow, TableLayer, TextLayer, VIEWPORT, VideoLayer, formatTime, useAudioSync, useAutoSurface, useDocPlayback, useMediaProvider, useMediaUrl, useViewportOrientation };
+export { type AudioActions, type AudioProvider, type AudioState, type BlockMarker, BlockRenderer, type CaptionMode, CaptionOverlay, type CaptionStyle, type ControlsLayout, type DisplayMode, DocControlsBottom, DocControlsOverlay, DocControlsSidebar, DocControlsSlideshow, DocPlayer, DocPlayerWithSidebar, DocProgressBar, type ImageDisplayMode, ImageLayer, InlineAudioPlayer, type InlineAudioPlayerProps, InlineVideoPlayer, type InlineVideoPlayerProps, JsonView, type JsonViewProps, LinearDocView, type LinearDocViewProps, MapLayer, MarkdownRenderer, MediaClipLayer, type MediaClipLayerProps, MediaContext, type MediaScheduleController, PathLayer, type PlaybackActions$1 as PlaybackActions, type PlaybackState$1 as PlaybackState, type RenderAudioSegmentInfo, type RenderBlockInfo, type RenderCaptionInfo, type RenderChapterInfo, ShapeLayer, type SlideNavActions, SocialCaptionOverlay, type SquisqRenderAPI, type SquisqWindow, TableLayer, TextLayer, VIEWPORT, VideoLayer, formatTime, useAudioSync, useAutoSurface, useDocPlayback, useMediaProvider, useMediaSchedule, useMediaUrl, useViewportOrientation };