autokap 1.0.7 → 1.0.8

package/dist/legacy/clip-orchestrator.d.ts

@@ -0,0 +1,148 @@
+import type { ClipDefinition, ClipOptions, LoginCredentials, VideoPlan, StepUsage, VideoPhase } from '../types.js';
+export interface ClipTarget {
+    id: string;
+    label: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+}
+export interface ClipOrchestratorConfig {
+    url: string;
+    clips: ClipDefinition[];
+    targets: ClipTarget[];
+    outputScale?: number;
+    langs: string[];
+    themes: Array<'light' | 'dark'>;
+    clipOptions?: ClipOptions;
+    credentials?: LoginCredentials;
+    model: string;
+    apiKey: string;
+    runId: string;
+    presetId?: string;
+    projectId?: string;
+    langInstructions?: string;
+    themeInstructions?: string;
+    navigationInstructions?: string;
+    abortSignal?: AbortSignal;
+    /** Fallback model used when the primary model fails to produce tool calls (e.g. in repair lane). */
+    fallbackModel?: string;
+    /** Per-clip timeout in milliseconds. Default: 180_000 (3 minutes). */
+    perClipTimeoutMs?: number;
+}
+export interface ClipVariantResult {
+    clipId: string;
+    clipName: string;
+    clipScript: string;
+    targetId: string;
+    targetLabel: string;
+    viewportWidth: number;
+    viewportHeight: number;
+    lang: string;
+    theme: string;
+    success: boolean;
+    gifPath?: string;
+    mp4Path?: string;
+    thumbnailPath?: string;
+    durationMs: number;
+    fileSizeBytes?: number;
+    plan?: VideoPlan;
+    stepsExecuted: number;
+    assessment: string;
+    failedPhase?: 'preflight' | 'planning' | 'dry_run' | 'recording' | 'postprocess';
+    failedStepIndex?: number;
+    failedSubphase?: string;
+    usage: StepUsage[];
+}
+export interface ClipOrchestratorResult {
+    results: ClipVariantResult[];
+    totalClips: number;
+    successCount: number;
+}
+export interface ClipOrchestratorCallbacks {
+    onClipStart?: (data: {
+        clipId: string;
+        clipName: string;
+        variantId: string;
+        target: {
+            width: number;
+            height: number;
+        };
+        lang: string;
+        theme: string;
+        clipIndex: number;
+        totalClips: number;
+    }) => void;
+    onClipPhase?: (data: {
+        clipId: string;
+        variantId: string;
+        phase: VideoPhase;
+    }) => void;
+    onClipStep?: (data: {
+        clipId: string;
+        variantId: string;
+        stepIndex: number;
+        total: number;
+        description: string;
+        phase: 'dry_run' | 'recording';
+    }) => void;
+    onClipStepResult?: (data: {
+        clipId: string;
+        variantId: string;
+        stepIndex: number;
+        ok: boolean;
+        reason?: string;
+    }) => void;
+    onClipRecordingDone?: (data: {
+        clipId: string;
+        variantId: string;
+        success: boolean;
+        gifPath?: string;
+        mp4Path?: string;
+        thumbnailPath?: string;
+        durationMs: number;
+        fileSizeBytes?: number;
+        lang: string;
+        theme: string;
+        targetId: string;
+        targetLabel: string;
+        assessment?: string;
+        failedPhase?: 'preflight' | 'planning' | 'dry_run' | 'recording' | 'postprocess';
+        failedStepIndex?: number;
+        failedSubphase?: string;
+    }) => void;
+    onClipPostprocessStart?: (data: {
+        clipId: string;
+        variantId: string;
+    }) => void;
+    onClipPostprocessDone?: (data: {
+        clipId: string;
+        variantId: string;
+        success: boolean;
+        gifPath?: string;
+        mp4Path?: string;
+    }) => void;
+    onClipsAllDone?: (data: {
+        totalClips: number;
+        successCount: number;
+    }) => void;
+    onLog?: (entry: {
+        level: string;
+        message: string;
+        timestamp: number;
+    }) => void;
+    /** Emit a live Playwright screenshot (base64 JPEG) for real-time preview in the UI. */
+    onScreenshot?: (base64: string) => void;
+}
+/**
+ * Run the clip capture pipeline for all clips × targets × langs × themes.
+ *
+ * Hybrid pipeline:
+ * 1. For each (clip, target, lang) — navigate once with the screenshot agent
+ * 2. Share the navigation session across theme variants (light/dark)
+ * 3. For each variant: plan → validate selectors → record → post-process
+ *
+ * Navigation sharing: themes only affect `colorScheme` (a Playwright setting),
+ * so the same navigation session (cookies, localStorage, URL) is reused.
+ */
+export declare function runClipOrchestrator(config: ClipOrchestratorConfig, callbacks?: ClipOrchestratorCallbacks): Promise<ClipOrchestratorResult>;