screenci 0.0.62 → 0.0.64

package/README.md

@@ -15,23 +15,27 @@ npm init screenci@latest
 pnpm create screenci
 ```
 
-`init` creates a ready-to-run project in the current directory, installs
-dependencies, and installs Chromium by default. When using `npm init`, pass
+`init` creates a ready-to-run, self-contained `screenci/` directory ("the
+island") with its own dependencies, and installs Chromium by default. The
+island is deliberately isolated from any surrounding workspace, which makes
+installation reliable inside complex monorepos. When using `npm init`, pass
 extra initializer flags after `--`, for example
 `npm init screenci@latest -- --yes --package-manager pnpm`.
 
 ```text
-screenci.config.ts
-package.json
-tsconfig.json
-README.md
-.gitignore
-.env
-videos/
-  example.video.ts
-.github/workflows/screenci.yaml
+screenci/
+  screenci.config.ts
+  package.json
+  package-lock.json        # or pnpm-lock.yaml / yarn.lock
+  .gitignore
+  videos/
+    example.video.ts
+.github/workflows/screenci.yaml   # at the repo root, scoped to screenci/
 ```
 
+`screenci test` and `screenci record` work both from inside `screenci/` and
+from the repository root.
+
 Docs:
 
 - Getting started: `https://screenci.com/docs`
@@ -89,13 +93,19 @@ Playwright without starting the final recording and upload path.
 ## Record the final output
 
 ```bash
-npx screenci login
 npx screenci record
 ```
 
-`login` saves `SCREENCI_SECRET` into the project env file. `record` writes local
-artifacts into `.screenci/<video-name>/` and uploads them when that secret is
-configured.
+On the first run without `SCREENCI_SECRET` in an interactive terminal, `record`
+prints a one-time ScreenCI link, waits for you to finish sign-in in the browser,
+saves the secret into the project env file, and then continues. In a
+non-interactive session (no terminal, or `SCREENCI_NONINTERACTIVE=1`) `record`
+does not wait: it prints the sign-in link and exits, so you can open the link,
+sign in, choose a plan, and rerun `record`, which then detects the completed
+session and continues. Set `SCREENCI_SECRET` ahead of time to skip sign-in
+entirely. Pending auth state is cached in `.screenci/link-session.json`, so
+rerunning `record` reuses the same link until it expires or completes. Recorded
+artifacts still live in `.screenci/<video-name>/`.
 
 ## Configure
 
@@ -123,6 +133,11 @@ export default defineConfig({
 ScreenCI manages `testDir`, `testMatch`, and `retries` for you. Most other
 Playwright config still passes through.
 
+If you keep local runtime secrets in an env file, point `envFile` at it or use
+the project `.env`. ScreenCI loads that file automatically for CLI commands.
+That is also the right place for BYOK-style secrets such as
+`ELEVENLABS_API_KEY`. ScreenCI does not store raw API keys from your env file.
+
 ## Authoring helpers
 
 | Export            | What it does                                              |
@@ -149,3 +164,7 @@ Playwright config still passes through.
 
 When `SCREENCI_SECRET` is configured, `screenci record` uploads the output to
 ScreenCI for rendering, narration generation, and hosted delivery.
+
+For narration authoring, keep cues short and usually one sentence at a time.
+That makes overlap timing easier to manage and should reduce TTS regeneration
+cost when only one line changes.

package/bin/screenci.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
-import { main } from '../dist/cli.js'
+import { logCliError, main } from '../dist/cli.js'
 
 main().catch((error) => {
-  console.error('Error:', error.message)
+  logCliError(error)
   process.exit(1)
 })

package/dist/cli.d.ts

@@ -8,6 +8,20 @@ type PlaywrightListReportSuite = {
     }>;
     suites?: PlaywrightListReportSuite[];
 };
+/**
+ * Reports whether the current session can complete an interactive browser
+ * sign-in. A session is interactive only when both stdin and stdout are
+ * attached to a terminal and no signal marks the run as automated. This is the
+ * proxy for "a human is present to open the sign-in link" — it does not attempt
+ * to identify any particular caller (CI, a piped shell, or an automated tool).
+ *
+ * Dependency-injected so tests can force a value without a real terminal.
+ */
+export declare function detectInteractiveSession(env?: NodeJS.ProcessEnv, stdout?: {
+    isTTY?: boolean;
+}, stdin?: {
+    isTTY?: boolean;
+}): boolean;
 export declare function collectPlaywrightListTitles(suites: readonly PlaywrightListReportSuite[]): string[];
 type PreparedUploadAsset = {
     fileHash: string;
@@ -17,7 +31,32 @@ type PreparedUploadAsset = {
     fileBuffer?: Buffer;
     contentType?: string;
 };
+export type StudioAppliedChange = {
+    kind?: string;
+    label?: string;
+    cue?: string;
+    language?: string;
+    from?: string;
+    to?: string;
+};
+export type UploadStudioInfo = {
+    held: true;
+} | {
+    appliedChanges: StudioAppliedChange[];
+};
+export type StudioUploadNotice = {
+    videoName: string;
+    videoId: string | null;
+    studio: UploadStudioInfo;
+};
+/**
+ * One-line summary of Studio overrides for CLI output, e.g.
+ * `recording.size (1 → 0.8), narration "intro" (en)`.
+ */
+export declare function formatStudioChangeSummary(changes: StudioAppliedChange[]): string;
+export declare function formatStudioUrl(appUrl: string, projectId: string, videoId: string): string;
 export declare function attachUploadAbortStdinListener(input: Pick<NodeJS.ReadStream, 'on' | 'off' | 'pause'>, onAbort: (signal: NodeJS.Signals) => void): () => void;
+export declare function collectUploadAssets(data: RecordingData, configDir: string): Promise<PreparedUploadAsset[]>;
 export declare function stripVoicePath(voice: VoiceKey | RecordingCustomVoiceRef): VoiceKey | RecordingCustomVoiceRef;
 export declare function annotateRecordingDataWithAssetHashes(data: RecordingData, assets: PreparedUploadAsset[]): RecordingData;
 export declare function formatUploadStartFailureMessage(videoName: string, status: number, responseText: string, secret: string): string;
@@ -25,20 +64,26 @@ export declare function formatFailedVideoMessage(videoName: string, message: str
 export declare function printUploadStartFailureMessage(videoName: string, status: number, responseText: string, secret: string): void;
 export declare function uploadRecordings(screenciDir: string, projectName: string, apiUrl: string, secret: string, specificEntry?: string, verbose?: boolean): Promise<{
     projectId: string | null;
+    recordId: string | null;
     hadFailures: boolean;
     failedVideoNames: string[];
     failedVideoMessages: Array<{
         videoName: string;
         message: string;
     }>;
+    studioNotices: StudioUploadNotice[];
 }>;
 export declare function getDevBackendUrl(): string;
 export declare function getDevFrontendUrl(): string;
+export declare function getCliLinkSessionApiUrl(): string;
 export declare function extractConfigStringLiteral(configSource: string, property: 'projectName' | 'envFile'): string | undefined;
 export declare function extractRecordUploadPolicyLiteral(configSource: string): RecordUploadPolicy | undefined;
 export declare function extractMockRecordLiteral(configSource: string): boolean | undefined;
 export declare function getConfigModuleSpecifier(resolvedConfigPath: string): string;
-export declare function ensureScreenciSecret(resolvedConfigPath?: string): Promise<string | undefined>;
+export declare function ensureScreenciSecret(resolvedConfigPath?: string, opts?: {
+    interactive?: boolean;
+}): Promise<string | undefined>;
 export declare function main(): Promise<void>;
+export declare function logCliError(error: unknown): void;
 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":"AA0BA,OAAO,KAAK,EACV,uBAAuB,EACvB,aAAa,EAEd,MAAM,iBAAiB,CAAA;AAMxB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAkB,MAAM,gBAAgB,CAAA;AA0BxE,KAAK,yBAAyB,GAAG;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAChC,MAAM,CAAC,EAAE,yBAAyB,EAAE,CAAA;CACrC,CAAA;AAUD,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,SAAS,yBAAyB,EAAE,GAC3C,MAAM,EAAE,CAiBV;AA6MD,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;AAuWD,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;AAqaD,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;AAQD,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,MAAM,CAeR;AAKD,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,MAAM,CASR;AAED,wBAAgB,8BAA8B,CAC5C,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,IAAI,CAcN;AAwGD,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,UAAQ,GACd,OAAO,CAAC;IACT,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,WAAW,EAAE,OAAO,CAAA;IACpB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,mBAAmB,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CACnE,CAAC,CAmFD;AAeD,wBAAgB,gBAAgB,IAAI,MAAM,CAKzC;AAED,wBAAgB,iBAAiB,IAAI,MAAM,CAK1C;AAoLD,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,aAAa,GAAG,SAAS,GAClC,MAAM,GAAG,SAAS,CAepB;AAED,wBAAgB,gCAAgC,CAC9C,YAAY,EAAE,MAAM,GACnB,kBAAkB,GAAG,SAAS,CAmBhC;AAED,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,MAAM,GACnB,OAAO,GAAG,SAAS,CAQrB;AAkCD,wBAAgB,wBAAwB,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAS3E;AAkRD,wBAAsB,oBAAoB,CACxC,kBAAkB,CAAC,EAAE,MAAM,GAC1B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAyB7B;AA8BD,wBAAsB,IAAI,kBAgTzB"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../cli.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EACV,uBAAuB,EACvB,aAAa,EAEd,MAAM,iBAAiB,CAAA;AAMxB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAE,kBAAkB,EAAkB,MAAM,gBAAgB,CAAA;AAoCxE,KAAK,yBAAyB,GAAG;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAChC,MAAM,CAAC,EAAE,yBAAyB,EAAE,CAAA;CACrC,CAAA;AAmDD;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,GAAE,MAAM,CAAC,UAAwB,EACpC,MAAM,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAmB,EAC5C,KAAK,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAkB,GACzC,OAAO,CAIT;AAED,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,SAAS,yBAAyB,EAAE,GAC3C,MAAM,EAAE,CAiBV;AA6MD,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;AASD,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,gBAAgB,GACxB;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,GACd;IAAE,cAAc,EAAE,mBAAmB,EAAE,CAAA;CAAE,CAAA;AAE7C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,gBAAgB,CAAA;CACzB,CAAA;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,OAAO,EAAE,mBAAmB,EAAE,GAC7B,MAAM,CAcR;AAED,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,MAAM,CAER;AAmWD,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;AAkaD,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAiGhC;AAED,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;AAQD,wBAAgB,+BAA+B,CAC7C,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,MAAM,CAeR;AAKD,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,MAAM,CASR;AAED,wBAAgB,8BAA8B,CAC5C,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,IAAI,CAcN;AAwGD,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,UAAQ,GACd,OAAO,CAAC;IACT,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,WAAW,EAAE,OAAO,CAAA;IACpB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,mBAAmB,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAClE,aAAa,EAAE,kBAAkB,EAAE,CAAA;CACpC,CAAC,CAyGD;AAeD,wBAAgB,gBAAgB,IAAI,MAAM,CAazC;AAED,wBAAgB,iBAAiB,IAAI,MAAM,CAa1C;AAED,wBAAgB,uBAAuB,IAAI,MAAM,CAEhD;AAiLD,wBAAgB,0BAA0B,CACxC,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,aAAa,GAAG,SAAS,GAClC,MAAM,GAAG,SAAS,CAepB;AAED,wBAAgB,gCAAgC,CAC9C,YAAY,EAAE,MAAM,GACnB,kBAAkB,GAAG,SAAS,CAmBhC;AAED,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,MAAM,GACnB,OAAO,GAAG,SAAS,CAQrB;AAkCD,wBAAgB,wBAAwB,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAS3E;AA+RD,wBAAsB,oBAAoB,CACxC,kBAAkB,CAAC,EAAE,MAAM,EAC3B,IAAI,GAAE;IAAE,WAAW,CAAC,EAAE,OAAO,CAAA;CAAO,GACnC,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAuG7B;AAED,wBAAsB,IAAI,kBA4UzB;AAuND,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAchD"}