screenci 0.0.10 → 0.0.12

package/README.md

@@ -82,79 +82,79 @@ export default defineConfig({
 
 screenci enforces `workers: 1`, `retries: 0`, and `fullyParallel: false` — FFmpeg records one screen at a time. Don't fight it.
 
-## Captions & AI voiceovers
+## AI voiceovers
 
-`createCaptions()` maps caption keys to text. At render time screenci sends the text through ElevenLabs and lines up the audio with your recording.
+`createVoiceOvers()` maps keys to narration text (or audio files). Define it once near the top of the file, then `await voiceOvers.key` inside `video()` wherever that spoken line should begin. The audio keeps playing while your next actions run. Use `await voiceOvers.waitEnd()` only when an action must wait for the current line to finish.
 
 ```ts
-import { video, createCaptions } from 'screenci'
-
-const captions = createCaptions({
-  intro: 'Welcome to the dashboard.',
-  addButton: 'Click here to create a new project.',
+import { video, createVoiceOvers, voices } from 'screenci'
+
+const voiceOvers = createVoiceOvers({
+  voice: { name: voices.Aria },
+  languages: {
+    en: {
+      captions: {
+        intro: 'Welcome to the dashboard.',
+        addButton: 'Click here to create a new project.',
+      },
+    },
+  },
 })
 
 video('Dashboard walkthrough', async ({ page }) => {
   await page.goto('/dashboard')
 
-  await captions.intro.start()
-  // ...anything you do here plays over the voiceover...
-  await captions.intro.end()
-
+  await voiceOvers.intro
+  await page.locator('#reports').click()
   await page.locator('#new-project').click()
-  await captions.addButton.start()
-  await captions.addButton.end()
+
+  await voiceOvers.addButton
+  await voiceOvers.waitEnd()
 })
 ```
 
-### With a voice
+Use this pattern:
 
 ```ts
-import { createCaptions, voices } from 'screenci'
-
-const captions = createCaptions(
-  { voice: voices.en.Jude },
-  {
-    intro: 'Welcome to the dashboard.',
-    addButton: 'Click here to create a new project.',
-  }
-)
+const voiceOvers = createVoiceOvers({ ... })
+
+video('Example', async ({ page }) => {
+  await voiceOvers.intro // starts narration now
+  await page.click('#next') // runs while intro audio is still playing
+
+  await voiceOvers.details // auto-ends intro, then starts details
+  await voiceOvers.waitEnd() // only if the next action must wait
+  await page.click('#confirm')
+})
 ```
 
 ### Multi-language (type-safe)
 
-TypeScript will yell at you if any language is missing a key. That's a feature.
+TypeScript enforces that every language has the same keys. Missing a translation is a compile error.
 
 ```ts
-import { createCaptions, voices } from 'screenci'
-
-const captions = createCaptions({
-  en: {
-    voice: voices.en.Jude,
-    captions: {
-      intro: 'Welcome to the dashboard.',
-      addButton: 'Click here to create a new project.',
+import { createVoiceOvers, voices } from 'screenci'
+
+const voiceOvers = createVoiceOvers({
+  voice: { name: voices.Ava },
+  languages: {
+    en: {
+      captions: {
+        intro: 'Welcome to the dashboard.',
+        addButton: 'Click here to create a new project.',
+      },
     },
-  },
-  fi: {
-    voice: voices.fi.Martti,
-    captions: {
-      intro: 'Tervetuloa hallintapaneeliin.',
-      addButton: 'Klikkaa tästä luodaksesi uuden projektin.',
+    fi: {
+      voice: { name: voices.Nora },
+      captions: {
+        intro: 'Tervetuloa hallintapaneeliin.',
+        addButton: 'Klikkaa tästä luodaksesi uuden projektin.',
+      },
     },
   },
 })
 ```
 
-### Sync actions to audio
-
-```ts
-// Wait until the voiceover is 60% done, then perform the action
-await captions.intro.waitUntil('60%')
-await page.locator('#cta').click()
-await captions.intro.end()
-```
-
 ## Hide the boring parts
 
 `hide()` cuts a section from the final video. Perfect for logins, page loads, and test setup.
@@ -200,14 +200,14 @@ video('Profile settings', async ({ page }) => {
 
 ## API
 
-| Export           | What it does                                         |
-| ---------------- | ---------------------------------------------------- |
-| `defineConfig`   | Wraps Playwright config with screenci defaults       |
-| `video`          | Declares a video recording test                      |
-| `createCaptions` | Creates typed caption controllers with AI voiceovers |
-| `hide`           | Cuts a section from the final video                  |
-| `autoZoom`       | Smooth camera pan that follows interactions          |
-| `voices`         | Available voice constants (`voices.en.Jude`, etc.)   |
+| Export             | What it does                                                       |
+| ------------------ | ------------------------------------------------------------------ |
+| `defineConfig`     | Wraps Playwright config with screenci defaults                     |
+| `video`            | Declares a video recording test                                    |
+| `createVoiceOvers` | Creates typed voiceover controllers with AI-generated audio        |
+| `hide`             | Cuts a section from the final video                                |
+| `autoZoom`         | Smooth camera pan that follows interactions                        |
+| `voices`           | Available voice constants (`voices.Ava`, `voices.elevenlabs(...)`) |
 
 The `page` fixture inside `video()` is a `ScreenCIPage` — a Playwright `Page` with animated cursor support wired in on all locator methods.
 
@@ -223,5 +223,5 @@ The `page` fixture inside `video()` is a `ScreenCIPage` — a Playwright `Page`
 Upload to screenci.com for rendering, voiceover generation, and the permanent embed link:
 
 ```bash
-npm run upload-latest
+npm run retry
 ```

package/dist/Dockerfile

@@ -1,4 +1,4 @@
-# Recording runtime ───────────────────────────────────────────────────────────
+# ── Runtime image ─────────────────────────────────────────────────────────────
 FROM docker.io/library/node:25.2.1-slim
 
 WORKDIR /app
@@ -18,7 +18,6 @@ RUN printf '{"private":true,"workspaces":["screenci"]}' > package.json && npm in
 RUN npx playwright install chromium --with-deps
 
 # ── screenci build output ─────────────────────────────────────────────────────
-# Copy pre-built dist directly from the screenci package directory.
 COPY dist ./screenci/dist/
 
 # Explicit bin wrapper — no npm bin-linking magic needed.

package/dist/cli.d.ts

@@ -1,4 +1,25 @@
 #!/usr/bin/env -S npx tsx
+import type { RecordingCustomVoiceRef, RecordingData } from './src/events.js';
+import type { VoiceKey } from './src/voices.js';
+type PreparedUploadAsset = {
+    fileHash: string;
+    path: string;
+    size: number;
+    name?: string;
+    fileBuffer?: Buffer;
+    contentType?: string;
+};
+export declare function attachUploadAbortStdinListener(input: Pick<NodeJS.ReadStream, 'on' | 'off' | 'pause'>, onAbort: (signal: NodeJS.Signals) => void): () => void;
+declare const MIN_CONTAINER_RUNTIME_MAJOR_VERSION: {
+    readonly podman: 5;
+    readonly docker: 28;
+};
+type ContainerRuntimeName = keyof typeof MIN_CONTAINER_RUNTIME_MAJOR_VERSION;
+export declare function stripVoicePath(voice: VoiceKey | RecordingCustomVoiceRef): VoiceKey | RecordingCustomVoiceRef;
+export declare function annotateRecordingDataWithAssetHashes(data: RecordingData, assets: PreparedUploadAsset[]): RecordingData;
+export declare function getDevBackendUrl(): string;
+export declare function getDevFrontendUrl(): string;
 export declare function main(): Promise<void>;
-export declare function detectContainerRuntime(): string;
+export declare function detectContainerRuntime(forcedRuntime?: ContainerRuntimeName): string;
+export {};
 //# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../cli.ts"],"names":[],"mappings":";AAgzBA,wBAAsB,IAAI,kBA2JzB;AAqED,wBAAgB,sBAAsB,IAAI,MAAM,CAc/C"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../cli.ts"],"names":[],"mappings":";AAwBA,OAAO,KAAK,EACV,uBAAuB,EACvB,aAAa,EAEd,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AA4D/C,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAiBD,wBAAgB,8BAA8B,CAC5C,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,GAAG,KAAK,GAAG,OAAO,CAAC,EACtD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,KAAK,IAAI,GACxC,MAAM,IAAI,CAiBZ;AAuED,QAAA,MAAM,mCAAmC;;;CAG/B,CAAA;AAEV,KAAK,oBAAoB,GAAG,MAAM,OAAO,mCAAmC,CAAA;AAyhB5E,wBAAgB,cAAc,CAC5B,KAAK,EAAE,QAAQ,GAAG,uBAAuB,GACxC,QAAQ,GAAG,uBAAuB,CAKpC;AAED,wBAAgB,oCAAoC,CAClD,IAAI,EAAE,aAAa,EACnB,MAAM,EAAE,mBAAmB,EAAE,GAC5B,aAAa,CAqEf;AAmQD,wBAAgB,gBAAgB,IAAI,MAAM,CAKzC;AAED,wBAAgB,iBAAiB,IAAI,MAAM,CAK1C;AA8gBD,wBAAsB,IAAI,kBAsQzB;AAyJD,wBAAgB,sBAAsB,CACpC,aAAa,CAAC,EAAE,oBAAoB,GACnC,MAAM,CAoBR"}