demowright 0.1.0

package/dist/setup-D-Ut4FYK.d.mts

@@ -0,0 +1,63 @@
+import { BrowserContext } from "@playwright/test";
+
+//#region src/hud-overlay.d.ts
+/**
+ * Client-side HUD overlay scripts.
+ *
+ * Split into two parts for maximum compatibility:
+ * 1. Listener script — registered via addInitScript (no DOM mutation, runs early)
+ * 2. DOM injection script — executed via page.evaluate after navigation
+ */
+type HudOptions = {
+  cursor: boolean;
+  keyboard: boolean;
+  cursorStyle: "default" | "dot" | "crosshair";
+  keyFadeMs: number;
+};
+//#endregion
+//#region src/audio-writer.d.ts
+declare class AudioWriter {
+  private chunks;
+  private sampleRate;
+  private channels;
+  /**
+   * Called from the browser via page.exposeFunction.
+   * Receives interleaved stereo float32 samples.
+   */
+  addChunk(samples: number[], sampleRate: number): void;
+  /** Total samples collected (interleaved, so / channels for per-channel) */
+  get totalSamples(): number;
+  get duration(): number;
+  /**
+   * Write collected audio to a WAV file.
+   */
+  save(filePath: string): void;
+  /** Reset for reuse */
+  clear(): void;
+}
+//#endregion
+//#region src/setup.d.ts
+/**
+ * TTS provider for narrate().
+ * - string: URL template — %s is replaced with encodeURIComponent(text).
+ *   Must return audio (mp3/wav/ogg).
+ *   Example: "https://api.example.com/tts?text=%s"
+ * - function: receives text, returns audio Buffer/ArrayBuffer.
+ * - false: disabled (falls back to speechSynthesis, which may not work headless).
+ */
+type TtsProvider = false | string | ((text: string) => Promise<Buffer | ArrayBuffer>);
+type QaHudOptions = HudOptions & {
+  actionDelay: number; /** Enable audio capture via Web Audio API. Set to a file path to save WAV, or `true` for auto-path. */
+  audio: boolean | string; /** TTS provider for narrate(). See TtsProvider type. */
+  tts: TtsProvider; /** Automatically annotate (caption + TTS) the test title at the start of each test. */
+  autoAnnotate: boolean; /** Output directory for rendered videos. Default: `.demowright` */
+  outputDir: string;
+};
+declare const defaultOptions: QaHudOptions;
+/**
+ * Apply the demowright HUD to an existing BrowserContext.
+ * Returns an AudioWriter if audio capture is enabled (call .save() after test).
+ */
+declare function applyHud(context: BrowserContext, options?: Partial<QaHudOptions>): Promise<AudioWriter | undefined>;
+//#endregion
+export { AudioWriter as a, defaultOptions as i, TtsProvider as n, applyHud as r, QaHudOptions as t };

package/dist/setup.d.mts

@@ -0,0 +1,2 @@
+import { i as defaultOptions, n as TtsProvider, r as applyHud, t as QaHudOptions } from "./setup-D-Ut4FYK.mjs";
+export { QaHudOptions, TtsProvider, applyHud, defaultOptions };

package/dist/setup.mjs

@@ -0,0 +1,2 @@
+import { n as defaultOptions, t as applyHud } from "./setup-CfPylVYx.mjs";
+export { applyHud, defaultOptions };

package/dist/video-script.d.mts

@@ -0,0 +1,134 @@
+import { Page } from "@playwright/test";
+
+//#region src/video-script.d.ts
+type TtsProviderType = string | ((text: string) => Promise<Buffer | ArrayBuffer>);
+/** Pace function — call between actions to auto-distribute remaining narration time. */
+type PaceFn = () => Promise<void>;
+type SegmentAction = (pace: PaceFn) => Promise<void>;
+type TransitionType = "fade" | "crossfade" | "none";
+interface TitleStep {
+  kind: "title";
+  text: string;
+  subtitle?: string;
+  durationMs: number;
+  background?: string;
+}
+interface SegmentStep {
+  kind: "segment";
+  text: string;
+  action?: SegmentAction;
+}
+interface TransitionStep {
+  kind: "transition";
+  type: TransitionType;
+  durationMs: number;
+}
+interface OutroStep {
+  kind: "outro";
+  text: string;
+  subtitle?: string;
+  durationMs: number;
+  background?: string;
+}
+type ScriptStep = TitleStep | SegmentStep | TransitionStep | OutroStep;
+interface TimelineEntry {
+  id: string;
+  kind: ScriptStep["kind"];
+  text: string;
+  startMs: number;
+  durationMs: number;
+  actionMs: number;
+  overrunMs: number;
+}
+interface VideoScriptResult {
+  timeline: TimelineEntry[];
+  totalMs: number;
+  srtContent: string;
+  srtPath?: string;
+  chaptersContent: string;
+  mp4Path?: string;
+  wavPath?: string;
+  /** Full ffmpeg command for post-processing (printed when render completes). */
+  ffmpegCommand?: string;
+}
+interface TitleOptions {
+  subtitle?: string;
+  durationMs?: number;
+  /** CSS background — default: radial gradient */
+  background?: string;
+}
+interface OutroOptions {
+  text?: string;
+  subtitle?: string;
+  durationMs?: number;
+  background?: string;
+}
+interface RenderOptions {
+  /** Output directory for generated files. Default: tmp/ */
+  outputDir?: string;
+  /** Base name for output files (without extension). Default: auto-generated */
+  baseName?: string;
+}
+/**
+ * Build a complete ffmpeg command that:
+ * 1. Muxes video + audio
+ * 2. Applies fade transitions at the correct offsets
+ * 3. Burns in SRT subtitles
+ * 4. Embeds chapter metadata
+ */
+declare function buildFfmpegCommand(videoPath: string, wavPath: string, srtPath: string, chaptersPath: string, mp4Path: string, timeline: {
+  kind: string;
+  type?: string;
+  startMs: number;
+  durationMs: number;
+}[]): string;
+declare class VideoScriptImpl {
+  private steps;
+  private counter;
+  private prepared;
+  private static ttsCache;
+  /**
+   * Add a title card — full-screen overlay with text + optional subtitle.
+   * No TTS narration by default (silent title card).
+   */
+  title(text: string, opts?: TitleOptions): this;
+  /**
+   * Add a narrated segment — TTS audio drives timing, callback runs paced actions.
+   * Same as NarrationPlan's `.annotate()` but named `.segment()` for clarity.
+   */
+  segment(text: string, action?: SegmentAction): this;
+  /**
+   * Add a transition between segments.
+   * Applied as an ffmpeg filter during render.
+   */
+  transition(type?: TransitionType, durationMs?: number): this;
+  /**
+   * Add an outro card — full-screen overlay, similar to title.
+   */
+  outro(opts?: OutroOptions): this;
+  /**
+   * Pre-generate all TTS audio for segment steps.
+   * Call before page.goto() so video recording doesn't include TTS wait time.
+   */
+  prepare(pageOrProvider?: Page | TtsProviderType): Promise<void>;
+  /**
+   * Execute the script steps — run each step timed to its narration duration.
+   * Returns timeline + totalMs. Audio segments are stored in the registry
+   * for deferred track building at context close (setup.ts).
+   */
+  run(page: Page): Promise<VideoScriptResult>;
+  /**
+   * Execute the script and produce final output files:
+   * WAV audio track, SRT subtitles, chapter metadata.
+   * Audio mux with video happens at context close (setup.ts).
+   */
+  render(page: Page, opts?: RenderOptions): Promise<VideoScriptResult>;
+  private executeSteps;
+}
+/**
+ * Create a video script — narration-driven video production with title cards,
+ * transitions, auto-subtitles, and chapter markers.
+ */
+declare function createVideoScript(): VideoScriptImpl;
+//#endregion
+export { OutroOptions, PaceFn, RenderOptions, TimelineEntry, TitleOptions, VideoScriptResult, buildFfmpegCommand, createVideoScript };