@bendyline/squisq-editor-react 2.1.0 → 2.3.0

package/src/recorder/hooks/useStreamPreview.ts

@@ -1,47 +0,0 @@
-/**
- * useStreamPreview — binds a `MediaStream` to a `<video>` element's
- * `srcObject`. Decouples the preview surface from `useMediaRecorder`,
- * letting hosts compose the preview element however they like.
- */
-
-import { useEffect, type RefObject } from 'react';
-
-/**
- * Assign `stream` to `<video>.srcObject` whenever either changes; clears
- * it on unmount or when `stream` is `null`. The element is set to
- * `playsInline` + `muted` automatically because previewing your own
- * microphone with audio playthrough creates a feedback loop.
- *
- * @example
- * ```tsx
- * const videoRef = useRef<HTMLVideoElement>(null);
- * const { stream } = useMediaRecorder({ source: 'camera' });
- * useStreamPreview(videoRef, stream);
- * return <video ref={videoRef} autoPlay />;
- * ```
- */
-export function useStreamPreview(
-  ref: RefObject<HTMLVideoElement | null>,
-  stream: MediaStream | null,
-): void {
-  useEffect(() => {
-    const el = ref.current;
-    if (!el) return;
-    el.muted = true;
-    el.playsInline = true;
-    el.srcObject = stream;
-    if (stream) {
-      // Some browsers don't auto-play on srcObject assignment; trigger
-      // it explicitly and ignore the inevitable "user gesture required"
-      // rejections — the preview will play on the next interaction.
-      void el.play().catch(() => {});
-    }
-    return () => {
-      // Only detach when this effect is tearing down. Don't stop tracks
-      // — that's the recorder's responsibility.
-      if (el.srcObject === stream) {
-        el.srcObject = null;
-      }
-    };
-  }, [ref, stream]);
-}

package/src/recorder/insertMediaBlock.ts

@@ -1,30 +0,0 @@
-/**
- * insertMediaBlock — drop a recorded clip into the WYSIWYG editor as a
- * *top-level* block, not at the raw caret position.
- *
- * The recorder's media nodes (`TiptapVideo` / `TiptapAudio`) are block
- * atoms. A plain `insertContent` at a caret that happens to sit inside a
- * list item (or blockquote) nests the atom inside that container — and
- * `tiptapToMarkdown`'s list serializer emits only the item's inline text,
- * so the nested `<video>` / `<audio>` is silently dropped on the next
- * sync and never reaches the markdown source (so it also never shows up
- * as a timeline clip). Lifting the insertion to the position right after
- * the caret's top-level ancestor keeps the tag at document level, where
- * the serializer's block-media handler round-trips it.
- */
-import type { Editor } from '@tiptap/core';
-
-export interface MediaNodeSpec {
-  type: 'video' | 'audio';
-  attrs: Record<string, unknown>;
-}
-
-export function insertMediaBlock(editor: Editor, node: MediaNodeSpec): void {
-  const { $from } = editor.state.selection;
-  // `after(1)` is the position immediately after the depth-1 (top-level)
-  // ancestor of the selection — after the whole list / blockquote /
-  // paragraph the caret is in. Fall back to the document end for the rare
-  // depth-0 (node) selection.
-  const pos = $from.depth >= 1 ? $from.after(1) : editor.state.doc.content.size;
-  editor.chain().focus().insertContentAt(pos, node).run();
-}

package/src/recorder/sources/cameraStream.ts

@@ -1,32 +0,0 @@
-/**
- * Camera + microphone capture via `getUserMedia({ video, audio })`.
- */
-
-import { supportsUserMedia } from '../formats.js';
-
-export interface CameraStreamOptions {
-  /** Video track constraints (resolution, facing mode, frame rate). Pass `true` for browser default, or `false` to omit video. */
-  video?: boolean | MediaTrackConstraints;
-  /** Audio track constraints. Pass `true` for browser default, or `false` to omit audio. */
-  audio?: boolean | MediaTrackConstraints;
-}
-
-/**
- * Request a camera + mic `MediaStream`. Caller owns the stream and must
- * stop its tracks when done.
- *
- * Both tracks are requested by default. To capture video only, pass
- * `audio: false`; to capture audio only use {@link requestMicStream}
- * instead.
- *
- * @throws When `mediaDevices` is unavailable, or when the user denies
- *   permission.
- */
-export async function requestCameraStream(options?: CameraStreamOptions): Promise<MediaStream> {
-  if (!supportsUserMedia()) {
-    throw new Error('navigator.mediaDevices.getUserMedia is not available in this environment.');
-  }
-  const video = options?.video ?? true;
-  const audio = options?.audio ?? true;
-  return navigator.mediaDevices.getUserMedia({ video, audio });
-}

package/src/recorder/sources/micStream.ts

@@ -1,25 +0,0 @@
-/**
- * Microphone-only capture via `getUserMedia({ audio: true })`.
- */
-
-import { supportsUserMedia } from '../formats.js';
-
-/**
- * Request a microphone-only `MediaStream`. Caller owns the stream and
- * must stop its tracks when done.
- *
- * @param constraints - Optional audio constraints (sample rate, device
- *   id, echo cancellation, etc.). Defaults to `true` — let the browser
- *   pick.
- * @throws When `mediaDevices` is unavailable, or when the user denies
- *   permission (the underlying `getUserMedia` rejection propagates).
- */
-export async function requestMicStream(constraints?: MediaTrackConstraints): Promise<MediaStream> {
-  if (!supportsUserMedia()) {
-    throw new Error('navigator.mediaDevices.getUserMedia is not available in this environment.');
-  }
-  return navigator.mediaDevices.getUserMedia({
-    audio: constraints ?? true,
-    video: false,
-  });
-}

package/src/recorder/sources/screenStream.ts

@@ -1,162 +0,0 @@
-/**
- * Screen capture via `getDisplayMedia`, with optional microphone mixing.
- *
- * The browser-native `getDisplayMedia({ audio: true })` flag only
- * captures *system* audio (and only on Chromium on desktop). For
- * narrated screencasts, hosts usually want the speaker's voice too —
- * we provide an opt-in "include mic" path that pulls a parallel
- * `getUserMedia` audio track and mixes it into the screen stream via
- * `AudioContext`, so the resulting `MediaStream` carries a single audio
- * track and a single video track.
- */
-
-import { supportsDisplayMedia, supportsUserMedia } from '../formats.js';
-
-export interface ScreenStreamOptions {
-  /** Video constraints for the screen surface. Pass `true` for browser default. */
-  video?: boolean | MediaTrackConstraints;
-  /**
-   * Whether to attempt to capture the system audio (tab / window / monitor
-   * audio). Browser support is limited (desktop Chromium only); when the
-   * platform doesn't honor this flag, the resulting stream simply omits
-   * the system audio track.
-   */
-  systemAudio?: boolean;
-  /**
-   * Whether to also pull the microphone via `getUserMedia` and mix it
-   * into the resulting stream's audio track. When both `systemAudio` and
-   * `includeMicrophone` produce tracks, they're combined via
-   * `AudioContext` into a single output track.
-   */
-  includeMicrophone?: boolean;
-  /** Microphone track constraints, when `includeMicrophone` is true. */
-  microphoneConstraints?: MediaTrackConstraints;
-}
-
-/**
- * Combine zero-or-more audio source streams into one mixed output track
- * via an `AudioContext`. Returns `null` when no input tracks were
- * supplied so the caller can decide what to do.
- */
-function mixAudioTracks(streams: MediaStream[]): {
-  track: MediaStreamTrack;
-  context: AudioContext;
-} | null {
-  const sources = streams
-    .map((s) => s.getAudioTracks())
-    .flat()
-    .filter((t) => t.readyState === 'live');
-  if (sources.length === 0) return null;
-
-  const AC = window.AudioContext;
-  if (typeof AC === 'undefined') return null;
-  const ctx = new AC();
-  const dest = ctx.createMediaStreamDestination();
-  for (const track of sources) {
-    const src = ctx.createMediaStreamSource(new MediaStream([track]));
-    src.connect(dest);
-  }
-  const [mixed] = dest.stream.getAudioTracks();
-  if (!mixed) return null;
-  return { track: mixed, context: ctx };
-}
-
-/**
- * Handle returned by {@link requestScreenStream}. The `stream` is what
- * gets handed to `MediaRecorder`; the `dispose()` callback shuts down
- * any auxiliary resources (e.g. the mic-mix `AudioContext`). Callers
- * must also stop the stream's tracks via `stream.getTracks().forEach(t
- * => t.stop())` when done — `dispose()` cleans up everything that isn't
- * the stream itself.
- */
-export interface ScreenStreamHandle {
-  stream: MediaStream;
-  /** Auxiliary cleanup beyond the stream tracks. Safe to call multiple times. */
-  dispose: () => void;
-}
-
-/**
- * Request a screen-capture `MediaStream`, optionally with a mixed-in
- * microphone track. Caller owns the resulting stream.
- *
- * @throws When `getDisplayMedia` isn't available, or when the user
- *   cancels the picker / denies permission.
- */
-export async function requestScreenStream(
-  options?: ScreenStreamOptions,
-): Promise<ScreenStreamHandle> {
-  if (!supportsDisplayMedia()) {
-    throw new Error('navigator.mediaDevices.getDisplayMedia is not available in this environment.');
-  }
-  const video = options?.video ?? true;
-  const systemAudio = options?.systemAudio ?? false;
-  const includeMic = options?.includeMicrophone ?? false;
-
-  const displayStream = await navigator.mediaDevices.getDisplayMedia({
-    video,
-    audio: systemAudio,
-  });
-
-  if (!includeMic) {
-    return {
-      stream: displayStream,
-      dispose: () => {},
-    };
-  }
-
-  if (!supportsUserMedia()) {
-    // Fall back to display-only — the caller asked for mic but the
-    // platform can't deliver. Surfacing an error here would be more
-    // user-hostile than just dropping the requested addition.
-    return {
-      stream: displayStream,
-      dispose: () => {},
-    };
-  }
-
-  let micStream: MediaStream | null = null;
-  try {
-    micStream = await navigator.mediaDevices.getUserMedia({
-      audio: options?.microphoneConstraints ?? true,
-      video: false,
-    });
-  } catch (err: unknown) {
-    // Stop the screen tracks too so the user isn't left with a stranded
-    // capture indicator.
-    displayStream.getTracks().forEach((t) => t.stop());
-    throw err;
-  }
-
-  const mix = mixAudioTracks([displayStream, micStream]);
-
-  if (!mix) {
-    // No audio at all — just hand back the display stream and shut down
-    // the mic acquisition we made.
-    micStream.getTracks().forEach((t) => t.stop());
-    return {
-      stream: displayStream,
-      dispose: () => {},
-    };
-  }
-
-  // Build the output stream: video from display + a single mixed audio
-  // track. Replace any system-audio track that came back from
-  // getDisplayMedia (it's now folded into the mix).
-  const [videoTrack] = displayStream.getVideoTracks();
-  const output = new MediaStream();
-  if (videoTrack) output.addTrack(videoTrack);
-  output.addTrack(mix.track);
-
-  // Stop the now-unused raw audio tracks so the browser releases them;
-  // the mixed output keeps its own copies via the AudioContext graph.
-  displayStream.getAudioTracks().forEach((t) => t.stop());
-
-  const dispose = () => {
-    // Keep mic alive until disposal so the mix keeps producing audio.
-    micStream?.getTracks().forEach((t) => t.stop());
-    micStream = null;
-    void mix.context.close().catch(() => {});
-  };
-
-  return { stream: output, dispose };
-}

package/src/recorder/timingJson.ts

@@ -1,66 +0,0 @@
-/**
- * Build the `.timing.json` sidecar that pairs with a narration recording.
- *
- * The shape matches what `resolveAudioMapping()` in
- * `@bendyline/squisq` reads at runtime: `sourceText`, `duration`, and
- * `bookmarks[]`. Sidecars are stored at `<audio-path>.timing.json`
- * inside the same `ContentContainer`, so the recorder can drop them
- * alongside its audio file and have the existing audio-mapping pipeline
- * pick them up with no schema changes.
- */
-
-/**
- * Word-level timing bookmark — same shape as `AudioBookmark` in
- * `@bendyline/squisq`. Recorder output produces an empty `bookmarks`
- * array; word-level timing is the domain of TTS pipelines, not
- * browser-side dictation.
- */
-export interface RecordedBookmark {
-  id: string;
-  time: number;
-  charOffset: number;
-  textFragment?: string;
-}
-
-export interface TimingJson {
-  /** Plain text the user said (or intended to say) during the recording. */
-  sourceText: string;
-  /** Recording length in seconds. */
-  duration: number;
-  /** Word-level timing data. Empty by default — populated only when a downstream tool aligns the audio. */
-  bookmarks: RecordedBookmark[];
-}
-
-/**
- * Build a `TimingJson` payload from a user-typed script and the
- * recording's measured duration. Both fields are required by the
- * downstream `parseTimingJson()` validator; missing them produces a
- * sidecar that gets silently dropped by the audio-mapping pipeline.
- */
-export function buildTimingJson(sourceText: string, durationSec: number): TimingJson {
-  return {
-    sourceText: sourceText ?? '',
-    duration: Number.isFinite(durationSec) && durationSec >= 0 ? durationSec : 0,
-    bookmarks: [],
-  };
-}
-
-/**
- * Serialize a `TimingJson` payload to a `Uint8Array` ready to hand to
- * `ContentContainer.writeFile()`. Pretty-printed so authors can hand-
- * edit the sidecar if they ever want to.
- */
-export function encodeTimingJson(timing: TimingJson): Uint8Array {
-  const text = JSON.stringify(timing, null, 2);
-  return new TextEncoder().encode(text);
-}
-
-/**
- * The container path convention `resolveAudioMapping()` expects:
- * `<audio-path>.timing.json`. Pass the audio file's relative path
- * (e.g. `'audio/narration-001.webm'`) and the matching sidecar path is
- * returned (`'audio/narration-001.webm.timing.json'`).
- */
-export function timingPathFor(audioRelativePath: string): string {
-  return `${audioRelativePath}.timing.json`;
-}

package/src/resolveBlockVisual.ts

@@ -1,39 +0,0 @@
-/**
- * resolveBlockVisual — resolves a doc block into a renderable card (with
- * `layers`) via the shared preview pipeline and canonical materializer.
- *
- * Kept in its own module (rather than alongside `BlockThumbnail` in
- * `TimelineBlockPreview.tsx`) so that component file exports only components,
- * which keeps React Fast Refresh working.
- */
-
-import type { Block, DocBlock, Doc, ViewportConfig, Theme } from '@bendyline/squisq/schemas';
-import { materializeBlockLayers, type MaterializeBlockLayersOptions } from '@bendyline/squisq/doc';
-import { buildPreviewDoc } from './buildPreviewDoc';
-
-/**
- * Resolve a doc block into a renderable card (with `layers`) via the shared
- * preview pipeline, or null when it can't be rendered.
- */
-export function resolveBlockVisual(
-  doc: Doc,
-  block: Block,
-  theme: Theme,
-  viewport: ViewportConfig,
-): Block | null {
-  try {
-    const slide = buildPreviewDoc({ ...doc, blocks: [block] }).blocks[0] as DocBlock | undefined;
-    if (!slide) return null;
-    const ctx: MaterializeBlockLayersOptions = {
-      blockIndex: 0,
-      totalBlocks: 1,
-      theme,
-      viewport,
-      customTemplates: doc.customTemplates,
-    };
-    const { layers } = materializeBlockLayers(slide, ctx);
-    return { ...(slide as unknown as Block), layers };
-  } catch {
-    return null;
-  }
-}